Mirror of
some changes
+58
-45
+2
-9
docs/astro.config.mjs
+2
-9
docs/astro.config.mjs
···
12
12
},
13
13
sidebar: [
14
14
{
15
-
label: "Guides",
16
-
items: [
17
-
// Each item here is one entry in the navigation menu.
18
-
{ label: "Example Guide", slug: "guides/example" },
19
-
],
20
-
},
21
-
{
22
-
label: "Reference",
23
-
autogenerate: { directory: "reference" },
15
+
label: "Start here",
16
+
items: [{ slug: "getting-started" }, { slug: "properties" }],
24
17
},
25
18
],
26
19
}),
+35
docs/src/content/docs/getting-started.mdx
+35
docs/src/content/docs/getting-started.mdx
···
1
+
---
2
+
title: Getting Started
3
+
---
4
+
5
+
Quickly display a link to some download asset on your Starlight site.
6
+
7
+
## Prerequisites
8
+
9
+
You will need to have a Starlight website set up.
10
+
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.
11
+
12
+
## Installation
13
+
14
+
import { Steps } from "@astrojs/starlight/components";
15
+
import PackageManagers from "starlight-package-managers";
16
+
17
+
<Steps>
18
+
19
+
1. Install the Starlight Package Managers component using your favorite package manager:
20
+
21
+
<PackageManagers pkg="starlight-download-link" />
22
+
23
+
2. Use the component in any MDX files of your Starlight documentation site.
24
+
25
+
```mdx title="src/content/docs/example.mdx"
26
+
import { DownloadLink } from "starlight-download-link";
27
+
28
+
<DownloadLink title="Example PDF" href="../assets/example.pdf" />
29
+
```
30
+
31
+
3. [Start the development server](https://starlight.astro.build/getting-started/#start-the-development-server) to preview the component.
32
+
33
+
</Steps>
34
+
35
+
The Starlight Download Link component has various [properties](/properties).
-11
docs/src/content/docs/guides/example.md
-11
docs/src/content/docs/guides/example.md
···
1
-
---
2
-
title: Example Guide
3
-
description: A guide in my new Starlight docs site.
4
-
---
5
-
6
-
Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
7
-
Writing a good guide requires thinking about what your users are trying to do.
8
-
9
-
## Further reading
10
-
11
-
- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
+14
-14
docs/src/content/docs/index.mdx
+14
-14
docs/src/content/docs/index.mdx
···
8
8
file: ../../assets/houston.webp
9
9
actions:
10
10
- text: Example Guide
11
-
link: /guides/example/
11
+
link: /getting-started/
12
12
icon: right-arrow
13
13
- text: Read the Starlight docs
14
14
link: https://starlight.astro.build
···
16
16
variant: minimal
17
17
---
18
18
19
-
import { Card, CardGrid } from '@astrojs/starlight/components';
19
+
import { Card, CardGrid } from "@astrojs/starlight/components";
20
20
21
21
## Next steps
22
22
23
23
<CardGrid stagger>
24
-
<Card title="Update content" icon="pencil">
25
-
Edit `src/content/docs/index.mdx` to see this page change.
26
-
</Card>
27
-
<Card title="Add new content" icon="add-document">
28
-
Add Markdown or MDX files to `src/content/docs` to create new pages.
29
-
</Card>
30
-
<Card title="Configure your site" icon="setting">
31
-
Edit your `sidebar` and other config in `astro.config.mjs`.
32
-
</Card>
33
-
<Card title="Read the docs" icon="open-book">
34
-
Learn more in [the Starlight Docs](https://starlight.astro.build/).
35
-
</Card>
24
+
<Card title="Update content" icon="pencil">
25
+
Edit `src/content/docs/index.mdx` to see this page change.
26
+
</Card>
27
+
<Card title="Add new content" icon="add-document">
28
+
Add Markdown or MDX files to `src/content/docs` to create new pages.
29
+
</Card>
30
+
<Card title="Configure your site" icon="setting">
31
+
Edit your `sidebar` and other config in `astro.config.mjs`.
32
+
</Card>
33
+
<Card title="Read the docs" icon="open-book">
34
+
Learn more in [the Starlight Docs](https://starlight.astro.build/).
35
+
</Card>
36
36
</CardGrid>
+7
docs/src/content/docs/properties.mdx
+7
docs/src/content/docs/properties.mdx
-11
docs/src/content/docs/reference/example.md
-11
docs/src/content/docs/reference/example.md
···
1
-
---
2
-
title: Example Reference
3
-
description: A reference page in my new Starlight docs site.
4
-
---
5
-
6
-
Reference pages are ideal for outlining how things work in terse and clear terms.
7
-
Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting.
8
-
9
-
## Further reading
10
-
11
-
- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework