docs/README.mdx
Live at https://gh-dash.dev.
In this project you'll see the following folders and files:
.
āāā public/
āāā src/
ā āāā assets/
ā āāā content/
ā ā āāā docs/
ā āāā content.config.ts
āāā astro.config.mjs
āāā package.json
āāā 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.
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.
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
pnpm install | Installs dependencies |
pnpm dev | Starts local dev server at localhost:4321 |
pnpm build | Build your production site to ./dist/ |
pnpm preview | Preview your build locally, before deploying |
pnpm astro ... | Run CLI commands like astro add, astro check |
pnpm astro -- --help | Get help using the Astro CLI |