diff --git a/docs/astro.config.ts b/docs/astro.config.ts index bd83559..f2ee07f 100644 --- a/docs/astro.config.ts +++ b/docs/astro.config.ts @@ -14,11 +14,15 @@ export default defineConfig({ sidebar: [ { label: "Start Here", - items: [{ slug: "getting-started" }, { slug: "components" }], + items: [ + { slug: "getting-started" }, + { slug: "add-hideoo" }, + { slug: "components" }, + ], }, { - label: "Showcase", - autogenerate: { directory: "showcase" }, + label: "Resources", + autogenerate: { directory: "resources" }, }, ], social: { diff --git a/docs/package.json b/docs/package.json index dbc0d6a..0f3f0a3 100644 --- a/docs/package.json +++ b/docs/package.json @@ -14,6 +14,7 @@ }, "dependencies": { "@astrojs/starlight": "^0.28.5", + "@hideoo/starlight-plugins-docs-components": "^0.2.2", "@trueberryless-org/starlight-plugins-docs-components": "workspace:*", "astro": "^4.16.8", "sharp": "^0.33.5", diff --git a/docs/src/content/docs/add-hideoo.mdx b/docs/src/content/docs/add-hideoo.mdx new file mode 100644 index 0000000..0e00cf9 --- /dev/null +++ b/docs/src/content/docs/add-hideoo.mdx @@ -0,0 +1,81 @@ +--- +title: Add Hideoo's components +--- + +[HiDeoo](https://github.com/HiDeoo) is a Starlight plugin developer. He also created a set of Starlight [components](https://github.com/HiDeoo/starlight-plugins-docs-components). If you want to add them to your Starlight website, you can follow the following steps: + +## Prerequisites + +You will need to have a Starlight website set up. +If you don't have one yet, you can follow the ["Getting Started"](https://starlight.astro.build/getting-started) guide in the Starlight docs to create one. + +## Installation + +import { Steps, Tabs, TabItem } from "@astrojs/starlight/components"; + + + +1. `@hideoo/starlight-plugins-docs-components` is a Starlight [plugin](https://starlight.astro.build/reference/plugins/). Install it by running the following command in your terminal: + + + + + + ```sh + npm install @hideoo/starlight-plugins-docs-components + ``` + + + + + + ```sh + pnpm add @hideoo/starlight-plugins-docs-components + ``` + + + + + + ```sh + yarn add @hideoo/starlight-plugins-docs-components + ``` + + + + + +2. Copy the following Markdoc content into your `src/content/docs/showcase/hideoo.mdx` file. + + ```astro title="resources/hideoo.mdx" + --- + title: Content from HiDeoo + description: Discover other Starlight plugins, components and tools developed by HiDeoo. + sidebar: + order: 3 + --- + + import { ResourcesIntro, Resources } from "@hideoo/starlight-plugins-docs-components"; + + :::note + We simply left this page as a thank you for [HiDeoo](https://github.com/HiDeoo). Be sure to check out the cool stuff below from this **legendary guy**! + ::: + + + + ## Plugins + + + + ## Components + + + + ## Tools + + + ``` + +3. [Start the development server](https://starlight.astro.build/getting-started/#start-the-development-server) to preview the plugin in action. + + diff --git a/docs/src/content/docs/getting-started.mdx b/docs/src/content/docs/getting-started.mdx index 882e96a..a0f74a4 100644 --- a/docs/src/content/docs/getting-started.mdx +++ b/docs/src/content/docs/getting-started.mdx @@ -2,7 +2,11 @@ title: Getting Started --- -Set of opinionated Starlight components used in trueberryless-org's Starlight plugins documentations +Set of opinionated Starlight components used in trueberryless-org's Starlight plugins documentations. + +:::note +Make sure to also check out [HiDeoo's docs components](https://github.com/HiDeoo/starlight-plugins-docs-components) for more Starlight components! If you wanna get started with his components, check out [the Getting Started guide](/add-hideoo). +::: ## Prerequisites @@ -79,6 +83,7 @@ import { Steps, Tabs, TabItem } from "@astrojs/starlight/components"; description: A collection of plugins and tools created by trueberryless-org sidebar: label: Plugins and Tools + order: 2 --- import { @@ -96,6 +101,8 @@ import { Steps, Tabs, TabItem } from "@astrojs/starlight/components"; --- title: Site Showcase description: A collection of sites using the YOUR_PLUGIN plugin. + sidebar: + order: 1 --- import { ShowcaseIntro, Showcase } from "@trueberryless-org/starlight-plugins-docs-components"; @@ -125,7 +132,38 @@ import { Steps, Tabs, TabItem } from "@astrojs/starlight/components"; /> ``` -5. [Start the development server](https://starlight.astro.build/getting-started/#start-the-development-server) to preview the plugin in action. +5. Copy the following Markdoc content into your `src/content/docs/showcase/hideoo.mdx` file. + + ```astro title="resources/hideoo.mdx" + --- + title: Content from HiDeoo + description: Discover other Starlight plugins, components and tools developed by HiDeoo. + sidebar: + order: 3 + --- + + import { ResourcesIntro, Resources } from "@hideoo/starlight-plugins-docs-components"; + + :::note + We simply left this page as a thank you for [HiDeoo](https://github.com/HiDeoo). Be sure to check out the cool stuff below from this **legendary guy**! + ::: + + + + ## Plugins + + + + ## Components + + + + ## Tools + + + ``` + +6. [Start the development server](https://starlight.astro.build/getting-started/#start-the-development-server) to preview the plugin in action. diff --git a/docs/src/content/docs/resources/hideoo.mdx b/docs/src/content/docs/resources/hideoo.mdx new file mode 100644 index 0000000..105516b --- /dev/null +++ b/docs/src/content/docs/resources/hideoo.mdx @@ -0,0 +1,26 @@ +--- +title: Content from HiDeoo +description: Discover other Starlight plugins, components and tools developed by HiDeoo. +sidebar: + order: 3 +--- + +import { ResourcesIntro, Resources } from "@hideoo/starlight-plugins-docs-components"; + +:::note +We simply left this page as a thank you for [HiDeoo](https://github.com/HiDeoo). Be sure to check out the cool stuff below from this **legendary guy** 🙌! +::: + + + +## Plugins + + + +## Components + + + +## Tools + + diff --git a/docs/src/content/docs/showcase/plugins.mdx b/docs/src/content/docs/resources/plugins.mdx similarity index 70% rename from docs/src/content/docs/showcase/plugins.mdx rename to docs/src/content/docs/resources/plugins.mdx index fa949f4..05a5bfc 100644 --- a/docs/src/content/docs/showcase/plugins.mdx +++ b/docs/src/content/docs/resources/plugins.mdx @@ -1,8 +1,9 @@ --- title: Starlight Plugins and Tools -description: A collection of plugins, components, tools and themes created by trueberryless-org +description: A collection of plugins and tools created by trueberryless-org sidebar: label: Plugins and Tools + order: 2 --- import { diff --git a/docs/src/content/docs/showcase/sites.mdx b/docs/src/content/docs/resources/sites.mdx similarity index 89% rename from docs/src/content/docs/showcase/sites.mdx rename to docs/src/content/docs/resources/sites.mdx index 0e05608..fdd9d80 100644 --- a/docs/src/content/docs/showcase/sites.mdx +++ b/docs/src/content/docs/resources/sites.mdx @@ -1,8 +1,8 @@ --- -title: Showcase -description: A collection of sites using the Starlight Sidebar Topics Dropdown plugin. +title: Site Showcase +description: A collection of sites using the Starlight Plugins Docs Components plugin. sidebar: - label: Sites + order: 1 --- import { ShowcaseIntro, Showcase } from "@trueberryless-org/starlight-plugins-docs-components"; diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index af59fbd..a7ebf08 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -13,6 +13,9 @@ importers: '@astrojs/starlight': specifier: ^0.28.5 version: 0.28.5(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)) + '@hideoo/starlight-plugins-docs-components': + specifier: ^0.2.2 + version: 0.2.2(@astrojs/starlight@0.28.5(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)))(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)) '@trueberryless-org/starlight-plugins-docs-components': specifier: workspace:* version: link:../packages/starlight-plugins-docs-components @@ -336,6 +339,12 @@ packages: '@expressive-code/plugin-text-markers@0.35.6': resolution: {integrity: sha512-/k9eWVZSCs+uEKHR++22Uu6eIbHWEciVHbIuD8frT8DlqTtHYaaiwHPncO6KFWnGDz5i/gL7oyl6XmOi/E6GVg==} + '@hideoo/starlight-plugins-docs-components@0.2.2': + resolution: {integrity: sha512-SJUoeDvdMLgETbYn2GPXI4IDy7l2kWcfA458M4a4a6kAtTAIdguRTDgqNjPAuCyV9s74VDdKLPh3KCUvUTfBGg==} + engines: {node: '>=18'} + peerDependencies: + '@astrojs/starlight': '>=0.24.0' + '@img/sharp-darwin-arm64@0.33.5': resolution: {integrity: sha512-UT4p+iz/2H4twwAoLCqfA9UH5pI6DggwKEGuaPy7nCVQ8ZsiY5PIcrRvD1DzuY3qYL07NtIQcWnBSY/heikIFQ==} engines: {node: ^18.17.0 || ^20.3.0 || >=21.0.0} @@ -1737,6 +1746,19 @@ packages: '@astrojs/starlight': '>=0.15.0' astro: '>=4.0.0' + starlight-package-managers@0.6.0: + resolution: {integrity: sha512-2tE0B4ZVEZXZ1LJjcSvVXLfJP8SB2nE+nhiFgSa3fuHUPtnbzmFxLVp7jEKD8jaMXKWPYtlNTy95gJSK9W1sbQ==} + engines: {node: '>=18.14.1'} + peerDependencies: + '@astrojs/starlight': '>=0.22.0' + astro: '>=4.2.7' + + starlight-showcases@0.1.2: + resolution: {integrity: sha512-yj3RjcdWLIWdehTjne9Ethd3ff95vMbuVx/87lU4yilTQewQxjnAyOf1KSnGUgTMQT5WTqhDw8LciPBJox+b8Q==} + engines: {node: '>=18'} + peerDependencies: + '@astrojs/starlight': '>=0.23.0' + starlight-showcases@0.2.0: resolution: {integrity: sha512-YWJuTqArkUdVJV85VKZJ0BvKCQRu1SKtH/Cr5t6G/oIfI4IptWc92E7BmiuNnpuQ2U7TczTRidCYurPrbgQQVA==} engines: {node: '>=18'} @@ -2304,6 +2326,14 @@ snapshots: dependencies: '@expressive-code/core': 0.35.6 + '@hideoo/starlight-plugins-docs-components@0.2.2(@astrojs/starlight@0.28.5(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)))(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3))': + dependencies: + '@astrojs/starlight': 0.28.5(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)) + starlight-package-managers: 0.6.0(@astrojs/starlight@0.28.5(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)))(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)) + starlight-showcases: 0.1.2(@astrojs/starlight@0.28.5(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)))(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)) + transitivePeerDependencies: + - astro + '@img/sharp-darwin-arm64@0.33.5': optionalDependencies: '@img/sharp-libvips-darwin-arm64': 1.0.4 @@ -4269,6 +4299,19 @@ snapshots: picomatch: 4.0.2 unist-util-visit: 5.0.0 + starlight-package-managers@0.6.0(@astrojs/starlight@0.28.5(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)))(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)): + dependencies: + '@astrojs/starlight': 0.28.5(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)) + astro: 4.16.8(rollup@4.24.3)(typescript@5.6.3) + + starlight-showcases@0.1.2(@astrojs/starlight@0.28.5(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)))(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)): + dependencies: + '@astro-community/astro-embed-twitter': 0.5.8(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)) + '@astro-community/astro-embed-youtube': 0.5.5(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)) + '@astrojs/starlight': 0.28.5(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)) + transitivePeerDependencies: + - astro + starlight-showcases@0.2.0(@astrojs/starlight@0.28.5(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)))(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3)): dependencies: '@astro-community/astro-embed-twitter': 0.5.8(astro@4.16.8(rollup@4.24.3)(typescript@5.6.3))