diff options
Diffstat (limited to 'src/content/docs')
| -rw-r--r-- | src/content/docs/guides/example.md | 11 | ||||
| -rw-r--r-- | src/content/docs/index.mdx | 40 | ||||
| -rw-r--r-- | src/content/docs/reference/example.md | 11 |
3 files changed, 62 insertions, 0 deletions
diff --git a/src/content/docs/guides/example.md b/src/content/docs/guides/example.md new file mode 100644 index 0000000..ebd0f3b --- /dev/null +++ b/src/content/docs/guides/example.md @@ -0,0 +1,11 @@ +--- +title: Example Guide +description: A guide in my new Starlight docs site. +--- + +Guides lead a user through a specific task they want to accomplish, often with a sequence of steps. +Writing a good guide requires thinking about what your users are trying to do. + +## Further reading + +- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx new file mode 100644 index 0000000..e6ed51f --- /dev/null +++ b/src/content/docs/index.mdx @@ -0,0 +1,40 @@ +--- +title: Welcome to Starlight +description: Get started building your docs site with Starlight. +template: splash # Remove or comment out this line to display the site sidebar on this page. +hero: + tagline: Congrats on setting up a new Starlight project! + image: + file: ../../assets/houston.webp + actions: + - text: Example Guide + link: /guides/example/ + icon: right-arrow + - text: Read the Starlight docs + link: https://starlight.astro.build + icon: external + variant: minimal +--- + +import { Card, CardGrid } from '@astrojs/starlight/components'; + +## Next steps + +<CardGrid stagger> + <Card title="Update content" icon="pencil"> + Edit `src/content/docs/index.mdx` to see this page change. + </Card> + <Card title="Change page layout" icon="document"> + Delete `template: splash` in `src/content/docs/index.mdx` to display a + sidebar on this page. + </Card> + <Card title="Add new content" icon="add-document"> + Add Markdown or MDX files to `src/content/docs` to create new pages. + </Card> + <Card title="Configure your site" icon="setting"> + Edit your `sidebar` and other config in `astro.config.mjs`. + </Card> + <Card title="Read the docs" icon="open-book"> + Learn more in [the Starlight Docs](https://starlight.astro.build/). + </Card> +</CardGrid> diff --git a/src/content/docs/reference/example.md b/src/content/docs/reference/example.md new file mode 100644 index 0000000..0224f09 --- /dev/null +++ b/src/content/docs/reference/example.md @@ -0,0 +1,11 @@ +--- +title: Example Reference +description: A reference page in my new Starlight docs site. +--- + +Reference pages are ideal for outlining how things work in terse and clear terms. +Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting. + +## Further reading + +- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework |