Skip to content

Commit

Permalink
docs: add reference to writing how-to guides
Browse files Browse the repository at this point in the history
  • Loading branch information
jceb committed May 22, 2024
1 parent 95455bd commit 73fd85c
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,14 @@ npm create astro@latest -- --template starlight

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
## On how to write how-to guides

[https://diataxis.fr/how-to-guides/]()

## 🚀 Project Structure

Inside of your Astro + Starlight project, you'll see the following folders and files:
Inside of your Astro + Starlight project, you'll see the following folders and
files:

```
.
Expand All @@ -30,9 +35,11 @@ Inside of your Astro + Starlight project, you'll see the following folders and f
└── tsconfig.json
```

Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory.
Each file is exposed as a route based on its file name.

Images can be added to `src/assets/` and embedded in Markdown with a relative link.
Images can be added to `src/assets/` and embedded in Markdown with a relative
link.

Static assets, like favicons, can be placed in the `public/` directory.

Expand All @@ -51,4 +58,6 @@ All commands are run from the root of the project, from a terminal:

## 👀 Want to learn more?

Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
Check out [Starlight’s docs](https://starlight.astro.build/), read
[the Astro documentation](https://docs.astro.build), or jump into the
[Astro Discord server](https://astro.build/chat).

0 comments on commit 73fd85c

Please sign in to comment.