Skip to content

Commit

Permalink
add hideoo
Browse files Browse the repository at this point in the history
deploy
  • Loading branch information
trueberryless committed Nov 4, 2024
1 parent 2dcd2d8 commit a4d66b2
Show file tree
Hide file tree
Showing 8 changed files with 203 additions and 9 deletions.
10 changes: 7 additions & 3 deletions docs/astro.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
1 change: 1 addition & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
81 changes: 81 additions & 0 deletions docs/src/content/docs/add-hideoo.mdx
Original file line number Diff line number Diff line change
@@ -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";

<Steps>

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:

<Tabs syncKey="pkg">

<TabItem label="npm">

```sh
npm install @hideoo/starlight-plugins-docs-components
```

</TabItem>

<TabItem label="pnpm">

```sh
pnpm add @hideoo/starlight-plugins-docs-components
```

</TabItem>

<TabItem label="Yarn">

```sh
yarn add @hideoo/starlight-plugins-docs-components
```

</TabItem>

</Tabs>

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**!
:::
<ResourcesIntro />
## Plugins
<Resources type="plugins" />
## Components
<Resources type="components" />
## Tools
<Resources type="tools" />
```

3. [Start the development server](https://starlight.astro.build/getting-started/#start-the-development-server) to preview the plugin in action.

</Steps>
42 changes: 40 additions & 2 deletions docs/src/content/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@
title: Getting Started
---

Set of opinionated Starlight components used in trueberryless-org&#39;s Starlight plugins documentations
Set of opinionated Starlight components used in trueberryless-org&#39;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

Expand Down Expand Up @@ -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 {
Expand All @@ -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";
Expand Down Expand Up @@ -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**!
:::
<ResourcesIntro />
## Plugins
<Resources type="plugins" />
## Components
<Resources type="components" />
## Tools
<Resources type="tools" />
```

6. [Start the development server](https://starlight.astro.build/getting-started/#start-the-development-server) to preview the plugin in action.

</Steps>

Expand Down
26 changes: 26 additions & 0 deletions docs/src/content/docs/resources/hideoo.mdx
Original file line number Diff line number Diff line change
@@ -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** 🙌!
:::

<ResourcesIntro />

## Plugins

<Resources type="plugins" />

## Components

<Resources type="components" />

## Tools

<Resources type="tools" />
Original file line number Diff line number Diff line change
@@ -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 {
Expand Down
Original file line number Diff line number Diff line change
@@ -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";
Expand Down
43 changes: 43 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a4d66b2

Please sign in to comment.