Skip to content

Commit

Permalink
docs: add showcase section to the contributing guide (#1606)
Browse files Browse the repository at this point in the history
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
Co-authored-by: Elian <15145918+ElianCodes@users.noreply.github.com>
Co-authored-by: casungo <25723446+casungo@users.noreply.github.com>
Co-authored-by: Atharva <88548999+at-the-vr@users.noreply.github.com>
  • Loading branch information
5 people authored Mar 28, 2024
1 parent 126bb93 commit 2b7d906
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -254,3 +254,28 @@ To add a language, you will need its BCP-47 tag and a label. See [“Adding a ne
[gfi]: https://github.com/withastro/starlight/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+
[api-docs]: https://docs.astro.build/en/reference/integrations-reference/
[vitest]: https://vitest.dev/
## 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.
If you’ve built a documentation site with Starlight, adding it to the showcase 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 screenshot of your site to the `docs/src/assets/showcase/` directory. The image file must:
- Be a `.png` file and named after your site’s domain, e.g. `example.com.png`.
- Have the dimensions of 800 × 450 pixels.
3. Add a new entry for your website in `docs/src/components/showcase-sites.astro`.
- The new entry must be appended at the end of the existing list of sites.
- The `title` attribute must be the name of your site with no extra details.
- 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 `thumbnail` attribute must be the filename of the screenshot you added in step 2.
```diff
<Card title="Example" href="https://example.com" thumbnail="example.com.png" />
<Card title="Last Example" href="https://example.org" thumbnail="example.org.png" />
+ <Card title="Example" href="https://example.com" thumbnail="example.com.png" />
</FluidGrid>
```
4. Open a pull request on GitHub to add your changes.
2 changes: 1 addition & 1 deletion docs/src/content/docs/resources/showcase.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar:

:::tip[Add your own!]
Have you built a Starlight site?
Open a PR adding a link to this page!
[Open a PR](https://github.com/withastro/starlight/blob/main/CONTRIBUTING.md#showcase) adding a link to this page!
:::

## Sites
Expand Down

0 comments on commit 2b7d906

Please sign in to comment.