Back to Gh Dash

Docs Site

docs/README.mdx

4.23.21.5 KB
Original Source

Docs Site

Live at https://gh-dash.dev.

šŸš€ Project Structure

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.

šŸ§ž Commands

All commands are run from the root of the project, from a terminal:

CommandAction
pnpm installInstalls dependencies
pnpm devStarts local dev server at localhost:4321
pnpm buildBuild your production site to ./dist/
pnpm previewPreview your build locally, before deploying
pnpm astro ...Run CLI commands like astro add, astro check
pnpm astro -- --helpGet help using the Astro CLI