From 32225a0972d922a238b111f202e1f3644002b38d Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 13:49:19 +0100
Subject: [PATCH 01/21] Add Plugin and integration section
---
CONTRIBUTING.md | 34 ++++++++++++++++++++++++++++++++++
1 file changed, 34 insertions(+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6fedacf1e0e..70fa2dd1e89 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -288,6 +288,40 @@ To add a language, you will need its BCP-47 tag and a label. See [“Adding a ne
[vitest]: https://vitest.dev/
[playwright]: https://playwright.dev/
+## Plugins and Integrations
+
+It's great to see plugins and other integrations enhance or change features of Starlight.
+If you’ve built a Starlight plugin, theme or some other tool, adding it to the plugin page is just a pull request away!
+
+1. Set up a development environment by following the [“Setting up a development environment”](#setting-up-a-development-environment) instructions.
+2. Add a new entry for your plugin or tool in the right section in `docs/src/content/docs/resources/plugins.mdx`.
+
+ - The new entry must be appended at the end of an existing list.
+ - The `href` attribute must be the URL of your Starlight site. If your documentation is hosted on a subdomain or subdirectory, include that in the URL.
+ - The `title` attribute must be the name of your site with no extra details.
+ - The `description` attribute must be a short and accurate description of what your plugin or tool does or what your theme offers.
+
+ ```diff
+
+
+
+
+ ```
+
+4. Open a pull request on GitHub to add your changes.
+
## Showcase
We love to see websites built with Starlight and share them with the community on our [showcase](https://starlight.astro.build/resources/showcase/) page.
From f009d255cba42d975c0daa4acb2cfea0aee8a6a9 Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 14:11:01 +0100
Subject: [PATCH 02/21] fix spaces?
---
CONTRIBUTING.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 70fa2dd1e89..776423033e7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -303,20 +303,20 @@ If you’ve built a Starlight plugin, theme or some other tool, adding it to the
```diff
-
-
+ +
```
From 693abdda47047a3a39039592f7820f2b09f6fbe7 Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 14:12:07 +0100
Subject: [PATCH 03/21] fix spaces 2?
---
CONTRIBUTING.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 776423033e7..d8b954bf606 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -303,7 +303,7 @@ If you’ve built a Starlight plugin, theme or some other tool, adding it to the
```diff
@@ -312,11 +312,11 @@ If you’ve built a Starlight plugin, theme or some other tool, adding it to the
title="starlight-plugin-last-example"
description="Add badge to your headings."
/>
- +
+ + />
```
From b98ea992ca05c1ad401887b6fd22badab01359b7 Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 14:12:49 +0100
Subject: [PATCH 04/21] fix spaces 3?
---
CONTRIBUTING.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d8b954bf606..9288839b739 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -308,15 +308,15 @@ If you’ve built a Starlight plugin, theme or some other tool, adding it to the
description="Add blog to your documentation."
/>
- +
+ + />
```
From edadd03ea6ecf89f9ab2efc41b1481aa7ac4b7e4 Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 14:13:53 +0100
Subject: [PATCH 05/21] fix spaces 4?
---
CONTRIBUTING.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9288839b739..6b8c10e24cd 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -303,12 +303,12 @@ If you’ve built a Starlight plugin, theme or some other tool, adding it to the
```diff
-
From 93e0a73cbecea1eabd12b7651b0edd089992133a Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 14:15:18 +0100
Subject: [PATCH 06/21] fix spaces 5?
---
CONTRIBUTING.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6b8c10e24cd..310b9810dc8 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -303,7 +303,7 @@ If you’ve built a Starlight plugin, theme or some other tool, adding it to the
```diff
From 3df9603f2126baf317c1bd03eccfd5f56b585d96 Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 14:22:07 +0100
Subject: [PATCH 07/21] rework spaces
---
CONTRIBUTING.md | 30 +++++++++++++++---------------
1 file changed, 15 insertions(+), 15 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 310b9810dc8..7f5cc064015 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -302,21 +302,21 @@ If you’ve built a Starlight plugin, theme or some other tool, adding it to the
- The `description` attribute must be a short and accurate description of what your plugin or tool does or what your theme offers.
```diff
-
-
- +
+
+
+ +
```
From f3bfa44ef9552f9c603c1e409e3c961f42442999 Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 14:40:37 +0100
Subject: [PATCH 08/21] Add community content section
---
CONTRIBUTING.md | 37 ++++++++++++++++++++++++++++++++++++-
1 file changed, 36 insertions(+), 1 deletion(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7f5cc064015..642010f7ac1 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -291,6 +291,7 @@ To add a language, you will need its BCP-47 tag and a label. See [“Adding a ne
## Plugins and Integrations
It's great to see plugins and other integrations enhance or change features of Starlight.
+We have a collection of plugins and tools on our [plugins](https://starlight.astro.build/resources/plugins/) page.
If you’ve built a Starlight plugin, theme or some other tool, adding it to the plugin page is just a pull request away!
1. Set up a development environment by following the [“Setting up a development environment”](#setting-up-a-development-environment) instructions.
@@ -320,7 +321,41 @@ If you’ve built a Starlight plugin, theme or some other tool, adding it to the
```
-4. Open a pull request on GitHub to add your changes.
+3. Open a pull request on GitHub to add your changes.
+
+## Starlight-related content
+
+We love when people create content around Starlight and share it on our [community content](https://starlight.astro.build/resources/community-content/)
+If you’ve published some content that's related to Statlight, adding it to the community content page is just a pull request away!
+
+1. Set up a development environment by following the [“Setting up a development environment”](#setting-up-a-development-environment) instructions.
+2. Add a new entry for your content in the right section in `docs/src/content/docs/resources/community-content.mdx`.
+
+ - The new entry must be appended at the end of an existing list.
+ - The `href` attribute must be the URL to your content (post on X, some blog, ...). If your documentation is hosted on a subdomain or subdirectory, include that in the URL.
+ - The `title` attribute must be the name of your site with no extra details.
+ - The `description` attribute must be a short and accurate description of what the content is about.
+
+ ```diff
+
+
+ +
+
+ ```
+
+3. Open a pull request on GitHub to add your changes.
## Showcase
From 28a2fc1a88395fd1965619d3a556d9137c2150d2 Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 14:41:42 +0100
Subject: [PATCH 09/21] fix types and stuff
---
CONTRIBUTING.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 642010f7ac1..675fa5fd17e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -323,10 +323,10 @@ If you’ve built a Starlight plugin, theme or some other tool, adding it to the
3. Open a pull request on GitHub to add your changes.
-## Starlight-related content
+## Community Content
We love when people create content around Starlight and share it on our [community content](https://starlight.astro.build/resources/community-content/)
-If you’ve published some content that's related to Statlight, adding it to the community content page is just a pull request away!
+If you’ve published some content that's related to Starlight, adding it to the community content page is just a pull request away!
1. Set up a development environment by following the [“Setting up a development environment”](#setting-up-a-development-environment) instructions.
2. Add a new entry for your content in the right section in `docs/src/content/docs/resources/community-content.mdx`.
From 0f114e01b7ad79ce752ba4fe210bf07f5a117086 Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 14:49:11 +0100
Subject: [PATCH 10/21] start video section
---
CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++
1 file changed, 33 insertions(+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 675fa5fd17e..4345203dfb3 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -357,6 +357,39 @@ If you’ve published some content that's related to Starlight, adding it to the
3. Open a pull request on GitHub to add your changes.
+### Video Content
+
+If the content you want to share is a YouTube video, you should add a new entry to the [video content section](https://starlight.astro.build/resources/community-content/#video-content). These entries differ in their properties. Therefore, step 2 is a little bit different:
+
+1. Set up a development environment by following the [“Setting up a development environment”](#setting-up-a-development-environment) instructions.
+2. Add a new entry for your content in the video section in `docs/src/content/docs/resources/community-content.mdx`.
+
+ - The new entry must be appended at the end of an existing list of the video content section.
+ - The `href` attribute must be the URL to your YouTube video.
+ - The `title` attribute must be the YouTube title.
+ - The `description` attribute must be a short and accurate description of the video. If the YouTube description of your video is short, you can copy and paste it.
+
+ ```diff
+
+
+ +
+
+ ```
+
+3. Open a pull request on GitHub to add your changes.
+
## Showcase
We love to see websites built with Starlight and share them with the community on our [showcase](https://starlight.astro.build/resources/showcase/) page.
From 376048de04317a48282277e2d49a4a2b4adf9de0 Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 15:01:38 +0100
Subject: [PATCH 11/21] fix example
---
CONTRIBUTING.md | 34 +++++++++++++++++-----------------
1 file changed, 17 insertions(+), 17 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4345203dfb3..1ced0c21342 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -370,25 +370,25 @@ If the content you want to share is a YouTube video, you should add a new entry
- The `description` attribute must be a short and accurate description of the video. If the YouTube description of your video is short, you can copy and paste it.
```diff
-
-
- +
-
+ {
+ href: 'https://www.youtube.com/watch?v=5u0Ds7wzUeI',
+ title: 'Starlight by Astro',
+ description: 'Watch the official Starlight launch video',
+ },
+ {
+ href: 'https://www.youtube.com/shorts/zjOWezSzd18',
+ title: '🌟 SUB 1 MINUTE RUN',
+ description: 'Watch Ben launch a new Starlight site in under a minute!',
+ },
+ + {
+ + href: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
+ + title: 'Rick Astley - Never Gonna Give You Up (Official Music Video)k',
+ + description: "The official video for “Never Gonna Give You Up” by Rick Astley.",
+ + },
+ ]}
```
-3. Open a pull request on GitHub to add your changes.
+3. Open a pull request on GitHub to add your changes. Just please don't try to add “Never Gonna Give You Up” by Rick Astley to our videos like the example above ;)
## Showcase
From 1f38680358785422c24db96a3e0cb0cd824cb046 Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 15:02:46 +0100
Subject: [PATCH 12/21] fix spaces 6?
---
CONTRIBUTING.md | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1ced0c21342..8dce0ad2ca6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -371,21 +371,21 @@ If the content you want to share is a YouTube video, you should add a new entry
```diff
{
- href: 'https://www.youtube.com/watch?v=5u0Ds7wzUeI',
- title: 'Starlight by Astro',
- description: 'Watch the official Starlight launch video',
- },
- {
- href: 'https://www.youtube.com/shorts/zjOWezSzd18',
- title: '🌟 SUB 1 MINUTE RUN',
- description: 'Watch Ben launch a new Starlight site in under a minute!',
- },
+ href: 'https://www.youtube.com/watch?v=5u0Ds7wzUeI',
+ title: 'Starlight by Astro',
+ description: 'Watch the official Starlight launch video',
+ },
+ {
+ href: 'https://www.youtube.com/shorts/zjOWezSzd18',
+ title: '🌟 SUB 1 MINUTE RUN',
+ description: 'Watch Ben launch a new Starlight site in under a minute!',
+ },
+ {
+ href: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
+ title: 'Rick Astley - Never Gonna Give You Up (Official Music Video)k',
+ description: "The official video for “Never Gonna Give You Up” by Rick Astley.",
+ },
- ]}
+ ]}
```
3. Open a pull request on GitHub to add your changes. Just please don't try to add “Never Gonna Give You Up” by Rick Astley to our videos like the example above ;)
From 9f4b6b5fde32ed5a085a2ab270e73cd81175ab6b Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 15:03:20 +0100
Subject: [PATCH 13/21] fix spaces 7?
---
CONTRIBUTING.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8dce0ad2ca6..4d8cfe39ff9 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -380,11 +380,11 @@ If the content you want to share is a YouTube video, you should add a new entry
title: '🌟 SUB 1 MINUTE RUN',
description: 'Watch Ben launch a new Starlight site in under a minute!',
},
- + {
- + href: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
- + title: 'Rick Astley - Never Gonna Give You Up (Official Music Video)k',
- + description: "The official video for “Never Gonna Give You Up” by Rick Astley.",
- + },
+ + {
+ + href: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
+ + title: 'Rick Astley - Never Gonna Give You Up (Official Music Video)k',
+ + description: "The official video for “Never Gonna Give You Up” by Rick Astley.",
+ + },
]}
```
From e789b4541660a74eb22cff372012e2cd7344b980 Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 15:05:36 +0100
Subject: [PATCH 14/21] Add link to "Open a PR"
---
docs/src/content/docs/resources/plugins.mdx | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/src/content/docs/resources/plugins.mdx b/docs/src/content/docs/resources/plugins.mdx
index 828046735e8..ef0e38a7357 100644
--- a/docs/src/content/docs/resources/plugins.mdx
+++ b/docs/src/content/docs/resources/plugins.mdx
@@ -7,7 +7,7 @@ sidebar:
:::tip[Add your own!]
Have you built a plugin or a tool for Starlight?
-Open a PR adding a link to this page!
+[Open a PR](https://github.com/withastro/starlight/blob/main/CONTRIBUTING.md#plugins-and-integrations) adding a link to this page!
:::
## Plugins
From 853e2889dfff7c2b139d37e8bd28329da34dab55 Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 15:06:40 +0100
Subject: [PATCH 15/21] Add link to "Open a PR"
---
docs/src/content/docs/resources/community-content.mdx | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/src/content/docs/resources/community-content.mdx b/docs/src/content/docs/resources/community-content.mdx
index b908a1e6701..494cba45b4c 100644
--- a/docs/src/content/docs/resources/community-content.mdx
+++ b/docs/src/content/docs/resources/community-content.mdx
@@ -5,7 +5,7 @@ description: Discover community-produced guides, articles and videos to help you
:::tip[Add your own!]
Have you produced content about Starlight?
-Open a PR adding a link to this page!
+[Open a PR](https://github.com/withastro/starlight/blob/main/CONTRIBUTING.md#community-content) adding a link to this page!
:::
import { CardGrid, LinkCard } from '@astrojs/starlight/components';
From 424e9054f5f100d613290434f6d9e1e3114d0368 Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 15:07:26 +0100
Subject: [PATCH 16/21] Move import to the top
---
docs/src/content/docs/resources/plugins.mdx | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/src/content/docs/resources/plugins.mdx b/docs/src/content/docs/resources/plugins.mdx
index ef0e38a7357..b6f6a12f0c5 100644
--- a/docs/src/content/docs/resources/plugins.mdx
+++ b/docs/src/content/docs/resources/plugins.mdx
@@ -10,6 +10,8 @@ Have you built a plugin or a tool for Starlight?
[Open a PR](https://github.com/withastro/starlight/blob/main/CONTRIBUTING.md#plugins-and-integrations) adding a link to this page!
:::
+import { CardGrid, LinkCard } from '@astrojs/starlight/components';
+
## Plugins
[Plugins](/reference/plugins/) can customize Starlight configuration, UI, and behavior, while also being easy to share and reuse.
@@ -129,8 +131,6 @@ A theme is a Starlight plugin that changes the visual appearance of a site with
## Community tools and integrations
-import { CardGrid, LinkCard } from '@astrojs/starlight/components';
-
These community tools and integrations can be used to add features to your Starlight site.
From 0510c5061120c12b207cdd1f164c0995ebcb5c2c Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 15:19:56 +0100
Subject: [PATCH 17/21] revert movement of import statement
---
docs/src/content/docs/resources/plugins.mdx | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/src/content/docs/resources/plugins.mdx b/docs/src/content/docs/resources/plugins.mdx
index b6f6a12f0c5..ef0e38a7357 100644
--- a/docs/src/content/docs/resources/plugins.mdx
+++ b/docs/src/content/docs/resources/plugins.mdx
@@ -10,8 +10,6 @@ Have you built a plugin or a tool for Starlight?
[Open a PR](https://github.com/withastro/starlight/blob/main/CONTRIBUTING.md#plugins-and-integrations) adding a link to this page!
:::
-import { CardGrid, LinkCard } from '@astrojs/starlight/components';
-
## Plugins
[Plugins](/reference/plugins/) can customize Starlight configuration, UI, and behavior, while also being easy to share and reuse.
@@ -131,6 +129,8 @@ A theme is a Starlight plugin that changes the visual appearance of a site with
## Community tools and integrations
+import { CardGrid, LinkCard } from '@astrojs/starlight/components';
+
These community tools and integrations can be used to add features to your Starlight site.
From 883f240e262f4ce6f79d67e3df12b95aedbbb07d Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 16:13:16 +0100
Subject: [PATCH 18/21] make sentence more suitable
@delucis
---
CONTRIBUTING.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4d8cfe39ff9..92766825225 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -298,7 +298,7 @@ If you’ve built a Starlight plugin, theme or some other tool, adding it to the
2. Add a new entry for your plugin or tool in the right section in `docs/src/content/docs/resources/plugins.mdx`.
- The new entry must be appended at the end of an existing list.
- - The `href` attribute must be the URL of your Starlight site. If your documentation is hosted on a subdomain or subdirectory, include that in the URL.
+ - The `href` attribute must be the URL of the GitHub repository containing the plugin. You can also use other git providers of course. If your code is private and you can't share a link to any repository, just link to your website.
- The `title` attribute must be the name of your site with no extra details.
- The `description` attribute must be a short and accurate description of what your plugin or tool does or what your theme offers.
From e4403f3ebe48bf8fd049b79b40bc7a94dfa26dac Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 20:04:23 +0100
Subject: [PATCH 19/21] make one big section instead of 3
---
CONTRIBUTING.md | 128 +++++++++++++-----------------------------------
1 file changed, 34 insertions(+), 94 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 92766825225..664dfdab4f2 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -288,105 +288,45 @@ To add a language, you will need its BCP-47 tag and a label. See [“Adding a ne
[vitest]: https://vitest.dev/
[playwright]: https://playwright.dev/
-## Plugins and Integrations
+## Plugins, Integrations and Community Content
-It's great to see plugins and other integrations enhance or change features of Starlight.
-We have a collection of plugins and tools on our [plugins](https://starlight.astro.build/resources/plugins/) page.
-If you’ve built a Starlight plugin, theme or some other tool, adding it to the plugin page is just a pull request away!
+It's great to see new plugins, integrations, tools, themes or any other content you created being shared with the community on our pages ["Plugins and Integrations"](https://starlight.astro.build/resources/plugins/) and ["Community Content"](https://starlight.astro.build/resources/community-content/).
+If you’ve built a creation that's related to Starlight, adding it to one of these pages is just a pull request away!
1. Set up a development environment by following the [“Setting up a development environment”](#setting-up-a-development-environment) instructions.
-2. Add a new entry for your plugin or tool in the right section in `docs/src/content/docs/resources/plugins.mdx`.
+2. If you have developed any kind of software, add a new entry in `docs/src/content/docs/resources/plugins.mdx`. Articles, guides or video content are welcome in `docs/src/content/docs/resources/community-content.mdx`.
- The new entry must be appended at the end of an existing list.
- - The `href` attribute must be the URL of the GitHub repository containing the plugin. You can also use other git providers of course. If your code is private and you can't share a link to any repository, just link to your website.
- - The `title` attribute must be the name of your site with no extra details.
- - The `description` attribute must be a short and accurate description of what your plugin or tool does or what your theme offers.
-
- ```diff
-
-
- +
-
- ```
-
-3. Open a pull request on GitHub to add your changes.
-
-## Community Content
-
-We love when people create content around Starlight and share it on our [community content](https://starlight.astro.build/resources/community-content/)
-If you’ve published some content that's related to Starlight, adding it to the community content page is just a pull request away!
-
-1. Set up a development environment by following the [“Setting up a development environment”](#setting-up-a-development-environment) instructions.
-2. Add a new entry for your content in the right section in `docs/src/content/docs/resources/community-content.mdx`.
-
- - The new entry must be appended at the end of an existing list.
- - The `href` attribute must be the URL to your content (post on X, some blog, ...). If your documentation is hosted on a subdomain or subdirectory, include that in the URL.
- - The `title` attribute must be the name of your site with no extra details.
- - The `description` attribute must be a short and accurate description of what the content is about.
-
- ```diff
-
-
- +
-
- ```
-
-3. Open a pull request on GitHub to add your changes.
-
-### Video Content
-
-If the content you want to share is a YouTube video, you should add a new entry to the [video content section](https://starlight.astro.build/resources/community-content/#video-content). These entries differ in their properties. Therefore, step 2 is a little bit different:
-
-1. Set up a development environment by following the [“Setting up a development environment”](#setting-up-a-development-environment) instructions.
-2. Add a new entry for your content in the video section in `docs/src/content/docs/resources/community-content.mdx`.
-
- - The new entry must be appended at the end of an existing list of the video content section.
- - The `href` attribute must be the URL to your YouTube video.
- - The `title` attribute must be the YouTube title.
- - The `description` attribute must be a short and accurate description of the video. If the YouTube description of your video is short, you can copy and paste it.
-
- ```diff
- {
- href: 'https://www.youtube.com/watch?v=5u0Ds7wzUeI',
- title: 'Starlight by Astro',
- description: 'Watch the official Starlight launch video',
- },
- {
- href: 'https://www.youtube.com/shorts/zjOWezSzd18',
- title: '🌟 SUB 1 MINUTE RUN',
- description: 'Watch Ben launch a new Starlight site in under a minute!',
- },
- + {
- + href: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
- + title: 'Rick Astley - Never Gonna Give You Up (Official Music Video)k',
- + description: "The official video for “Never Gonna Give You Up” by Rick Astley.",
- + },
- ]}
- ```
+ - The structure of the list can be copied from existing items in this list. Generally speaking, there are two types of items, the `` HTML element and a `json` object, examples represented below respectfully:
+
+
+ ```diff
+
+ +
+
+ ```
+
+ ```diff
+ {
+ href: 'https://www.youtube.com/shorts/zjOWezSzd18',
+ title: '🌟 SUB 1 MINUTE RUN',
+ description: 'Watch Ben launch a new Starlight site in under a minute!',
+ },
+ + {
+ + href: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
+ + title: 'Rick Astley - Never Gonna Give You Up (Official Music Video)k',
+ + description: "The official video for “Never Gonna Give You Up” by Rick Astley.",
+ + },
+ ]}
+ ```
3. Open a pull request on GitHub to add your changes. Just please don't try to add “Never Gonna Give You Up” by Rick Astley to our videos like the example above ;)
From 7f1fbb5063bdc0b9bd2f0a6fcaf5fa657350be09 Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 20:05:16 +0100
Subject: [PATCH 20/21] Update community-content.mdx
---
docs/src/content/docs/resources/community-content.mdx | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/src/content/docs/resources/community-content.mdx b/docs/src/content/docs/resources/community-content.mdx
index 494cba45b4c..c295c062ce8 100644
--- a/docs/src/content/docs/resources/community-content.mdx
+++ b/docs/src/content/docs/resources/community-content.mdx
@@ -5,7 +5,7 @@ description: Discover community-produced guides, articles and videos to help you
:::tip[Add your own!]
Have you produced content about Starlight?
-[Open a PR](https://github.com/withastro/starlight/blob/main/CONTRIBUTING.md#community-content) adding a link to this page!
+[Open a PR](https://github.com/withastro/starlight/blob/main/CONTRIBUTING.md#plugins-integrations-and-community-content) adding a link to this page!
:::
import { CardGrid, LinkCard } from '@astrojs/starlight/components';
From 8214e5e0782843fd29b7722f1a4836ef84163fc5 Mon Sep 17 00:00:00 2001
From: trueberryless <99918022+trueberryless@users.noreply.github.com>
Date: Wed, 6 Nov 2024 20:05:48 +0100
Subject: [PATCH 21/21] Update plugins.mdx
---
docs/src/content/docs/resources/plugins.mdx | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/src/content/docs/resources/plugins.mdx b/docs/src/content/docs/resources/plugins.mdx
index ef0e38a7357..b3eeb3f2317 100644
--- a/docs/src/content/docs/resources/plugins.mdx
+++ b/docs/src/content/docs/resources/plugins.mdx
@@ -7,7 +7,7 @@ sidebar:
:::tip[Add your own!]
Have you built a plugin or a tool for Starlight?
-[Open a PR](https://github.com/withastro/starlight/blob/main/CONTRIBUTING.md#plugins-and-integrations) adding a link to this page!
+[Open a PR](https://github.com/withastro/starlight/blob/main/CONTRIBUTING.md#plugins-integrations-and-community-content) adding a link to this page!
:::
## Plugins