diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d98b28efef..e5958f3ee49 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -288,6 +288,48 @@ 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, Integrations and Community Content + +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. 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 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 ;) + ## 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. diff --git a/docs/src/content/docs/resources/community-content.mdx b/docs/src/content/docs/resources/community-content.mdx index 42e37370d73..a6896ad2f23 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#plugins-integrations-and-community-content) adding a link to this page! ::: import { CardGrid, LinkCard } from '@astrojs/starlight/components'; diff --git a/docs/src/content/docs/resources/plugins.mdx b/docs/src/content/docs/resources/plugins.mdx index 85deb701e46..1fbd39c9c0c 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-integrations-and-community-content) adding a link to this page! ::: ## Plugins