You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Starlight looks for `.md` or `.mdx` files in the `astro/src/content/docs/` directory. Each file is exposed as a route based on its file name.
31
+
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.
95
32
96
-
Images can be added to `astro/src/assets/` and embedded in Markdown with a relative link.
33
+
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
97
34
98
-
Static assets, like favicons, can be placed in the `astro/public/` directory.
35
+
Static assets, like favicons, can be placed in the `public/` directory.
99
36
100
37
## ✍️ Authoring
101
38
@@ -126,7 +63,7 @@ WebStorm has Grazie as a built-in spell checker and grammar checker, and support
126
63
* When linking to external resources, use the full URL using HTTPS.
127
64
* You can link to header anchors using the `#` symbol, for example `[multiple authentication methods](/identityserver/ui/federation.md#multiple-authentication-methods-for-users)`.
128
65
* Link relevant text. Prefer `learn more about [improving the sign-in experience]` over `click [here] to learn more`.
129
-
* Run `dotnet build.cs link-check` to build Astro for link validation (actual lychee check runs in CI).
66
+
* Run `npm run linkchecker` to validate all links (note this will ignore links to GitHub because of rate limits in place).
130
67
* When a markdown link is long (75+ characters) or a link is repeated multiple times on a page, prefer moving the link to the bottom of the file and using markdown anchor syntax `[test.cs][repo-test-file]`
131
68
132
69
### Markdown Style
@@ -147,7 +84,7 @@ WebStorm has Grazie as a built-in spell checker and grammar checker, and support
147
84
* Make sure examples are runnable and complete. The goal is "Copy-paste from docs". Include namespaces, a result, and other prerequisites that are not obvious to someone new to the code.
148
85
* Inline comments can be used to explain essential parts of the code. Expressive code can highlight line numbers, show diffs, and more.
149
86
* Mention NuGet packages as a `bash` code block showing how to install it (`dotnet add package ...`). Link to the NuGet Gallery.
150
-
* When referencing a property, field, class, or other symbol in text, use the `test` format instead of _test_.
87
+
* When referencing a property, field, class, or other symbol in text, use the `test` format instead of *test*.
151
88
* Values should also be back-ticked, especially HTTP Status codes like `404` or `401`.
152
89
* Make sure code blocks start at the very first character space and don't have excessive starting padding.
153
90
@@ -158,29 +95,30 @@ WebStorm has Grazie as a built-in spell checker and grammar checker, and support
158
95
* Always have a `date` property to set the creation/significant update date for a page. Use the `YYYY-MM-DD` format.
159
96
* Add the `sidebar` property and must include the `label` and `order`. The `label` is used in the menu, and should typically be shorter than the more descriptive `title`. For example:
160
97
161
-
```yaml
162
-
title: "Using IdentityServer As A Federation Gateway"
163
-
sidebar:
164
-
label: "Federation"
165
-
order: 1
166
-
```
98
+
```yaml
99
+
title: "Using IdentityServer As A Federation Gateway"
100
+
sidebar:
101
+
label: "Federation"
102
+
order: 1
103
+
```
167
104
168
105
## 🧞 Commands
169
106
170
-
Astro commands are run from the `astro/` directory:
107
+
All commands are run from the root of the project, from a terminal:
171
108
172
-
| Command | Action |
173
-
| :------ | :----- |
174
-
| `npm install` | Installs dependencies |
175
-
| `npm run dev` | Starts local dev server at `localhost:4321` |
176
-
| `npm run build` | Build production site (use `dotnet build.cs astro-build` instead) |
177
-
| `npm run preview` | Preview your build locally |
178
-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
0 commit comments