Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add plugins showcase #1275

Merged
merged 4 commits into from
Dec 18, 2023
Merged

Conversation

HiDeoo
Copy link
Member

@HiDeoo HiDeoo commented Dec 13, 2023

What kind of changes does this PR include?

  • Changes or translations of Starlight docs site content

Description

Following the release of the version 0.5.0 of the starlight-links-validator which is now a Starlight plugin, this PR brings back a plugins showcase that was initially part of #942 and removed as we only had one plugin at the time.

I tried to follow the structure from one of your suggestion but this might need some adjustments as you might have a better idea of how you want to showcase plugins.

I deliberately left the Add plugins to your site section out as a showcase did not seem to be the right place for it but I might be wrong.

Personal note: I feel like it would be weird to use a <LinkCard/> for individual official plugins as they have dedicated sections/headings altho I feel like official plugins are not emphasized enough compared to community plugins with their link cards.

Update: I updated the PR with this new suggestion which I personally think looks a bit better.

Copy link

changeset-bot bot commented Dec 13, 2023

⚠️ No Changeset found

Latest commit: 678d1e4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Dec 13, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
starlight ✅ Ready (Inspect) Visit Preview Dec 18, 2023 9:37am

Starlight [plugins](/reference/plugins/) can customize Starlight configuration, UI, and behavior, while also being easy to share and reuse.
This section lists the official plugins supported by the Starlight team and also community plugins that are maintained by Starlight users.

### Algolia DocSearch
Copy link
Sponsor Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if we are planning to support more official plugins in the future but I was thinking that maybe we could have an official plugins section and list the algolia plugin under that section.

I think this will help level the importance of official and community plugins which will encourage more people to share their creations.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think you're totally right. I updated the PR to add an "Official plugins" section and if we want to go back to a structure closer to the suggested one, we can easily revert or tweak it.

Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for circling back to this @HiDeoo! Left a couple of small notes but overall this looks great and a nice improvement 🙌

docs/src/content/docs/showcase.mdx Outdated Show resolved Hide resolved
docs/src/content/docs/showcase.mdx Outdated Show resolved Hide resolved
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
@HiDeoo HiDeoo merged commit 87659f0 into withastro:main Dec 18, 2023
8 checks passed
HiDeoo added a commit to HiDeoo/starlight that referenced this pull request Dec 29, 2023
* main: (116 commits)
  [ci] format
  showcase: Add doc link of Mr. Robøt (withastro#1312)
  i18n(hi): update `project-structure.mdx` (withastro#1315)
  i18n(fr): Update `showcase.mdx` (withastro#1306)
  Add Concepto AI to Showcase Docs list (withastro#1307)
  showcase: Add docs.ghostfam.com (withastro#1314)
  i18n(ja): Update showcase.mdx and related pages (withastro#1294)
  i18n(ko-KR): update `showcase.mdx` (withastro#1304)
  docs: move `starlight-typedoc` to the community plugins section (withastro#1301)
  i18n(ja): Update frontmatter.md (withastro#1293)
  i18n(ko-KR): update `showcase.mdx` (withastro#1292)
  i18n(ko-KR): update `plugins.md` (withastro#1291)
  i18n(ko-KR): update `configuration.mdx` (withastro#1290)
  [ci] format
  [ci] release (withastro#1281)
  i18n(fr): add expressive code french translations (withastro#1289)
  [i18nIgnore] docs: revert some translated default UI strings (withastro#1288)
  i18n(fr): add plugin showcase (withastro#1287)
  i18n(fr): update `reference/frontmatter.md` (withastro#1286)
  docs: Add plugins showcase (withastro#1275)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 docs Documentation website changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants