This documentation site is built with Astro and Starlight. The sections below describe the site's structure and the commands for installation, local development and build instructions.
Inside of this Astro + Starlight project, there exist the following folders and files:
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ │ └── config.ts
│ └── env.d.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.
Note
MDX combines JSX and Markdown to make it easier to write component-driven content like tabbed code blocks.
Starlight requires that you work with .mdx files instead of .md when using JSX components. See the official
documentation for more information on MDX syntax and why it exists.
Images are added to src/assets/ and embedded in Markdown with a relative link.
Any additional static assets (like fonts, favicon, PDFs, etc.) that will not be processed by Astro
are placed in the public/ directory.
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm start |
Starts local server and builds site |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run astro ... |
Run CLI commands like astro add, astro check |
npm run astro -- --help |
Get help using the Astro CLI |
Check out Starlight’s docs and read the Astro documentation for further customization of the site.
A CI pipeline is configured to deploy the documentation to the server. The pipeline is triggered when a commit is pushed to the main branch. The CI pipeline will automatically build the documentation and deploy it to https://docs.kuzudb.com.