From 87659f061ea6d73be4bd48063a2e3f025adb0514 Mon Sep 17 00:00:00 2001 From: HiDeoo Date: Mon, 18 Dec 2023 10:39:08 +0100 Subject: docs: Add plugins showcase (#1275) Co-authored-by: Chris Swithinbank <357379+delucis@users.noreply.github.com> Co-authored-by: Kevin Zuniga Cuellar <46791833+kevinzunigacuellar@users.noreply.github.com>--- docs/src/content/docs/reference/configuration.mdx | 2 ++ docs/src/content/docs/reference/plugins.md | 2 +- docs/src/content/docs/showcase.mdx | 36 ++++++++++++++++++----- 3 files changed, 31 insertions(+), 9 deletions(-) diff --git a/docs/src/content/docs/reference/configuration.mdx b/docs/src/content/docs/reference/configuration.mdx index 1247f395..c3bc97ab 100644 --- a/docs/src/content/docs/reference/configuration.mdx +++ b/docs/src/content/docs/reference/configuration.mdx @@ -537,6 +537,8 @@ See the [Overrides Reference](/reference/overrides/) for details of all the comp Extend Starlight with custom plugins. Plugins apply changes to your project to modify or add to Starlight's features. +Visit the [plugins showcase](/showcase/#plugins) to see a list of available plugins. + ```js starlight({ plugins: [starlightPlugin()], diff --git a/docs/src/content/docs/reference/plugins.md b/docs/src/content/docs/reference/plugins.md index a6e50379..c5727e3e 100644 --- a/docs/src/content/docs/reference/plugins.md +++ b/docs/src/content/docs/reference/plugins.md @@ -8,7 +8,7 @@ tableOfContents: Starlight plugins can customize Starlight configuration, UI, and behavior, while also being easy to share and reuse. This reference page documents the API that plugins have access to. -Learn more about using a Starlight plugin in the [Configuration Reference](/reference/configuration/#plugins). +Learn more about using a Starlight plugin in the [Configuration Reference](/reference/configuration/#plugins) or visit the [plugins showcase](/showcase/#plugins) to see a list of available plugins. ## Quick API Reference diff --git a/docs/src/content/docs/showcase.mdx b/docs/src/content/docs/showcase.mdx index 194caafd..15f660d4 100644 --- a/docs/src/content/docs/showcase.mdx +++ b/docs/src/content/docs/showcase.mdx @@ -4,7 +4,7 @@ description: Discover sites built with Starlight and community tools that extend --- :::tip[Add your own!] -Have you built a Starlight site or a tool for Starlight? +Have you built a Starlight site, plugin, or a tool for Starlight? Open a PR adding a link to this page! ::: @@ -18,11 +18,36 @@ Starlight is already being used in production. These are some of the sites aroun See all the [public project repos using Starlight on GitHub](https://github.com/withastro/starlight/network/dependents). -## Community plugins +## Plugins + +[Plugins](/reference/plugins/) can customize Starlight configuration, UI, and behavior, while also being easy to share and reuse. +Extend your site with official plugins supported by the Starlight team and community plugins maintained by Starlight users. + +### Official plugins + + + + + +### Community plugins + + + + + +## Community tools and integrations import { CardGrid, LinkCard } from '@astrojs/starlight/components'; -These community tools, plugins, and integrations work alongside Starlight to extend its functionality. +These community tools and integrations can be used to add features to your Starlight site. -