Chapter: README (docs/README.md)
<br>
<p align="center">
<p align="center">
<img src="https://astro.badg.es/v2/built-with-starlight/tiny.svg">
</p>
</p>
<br>
π Run
To run the documentation locally, clone the repository and run:
npm run devπ§ Commands
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 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 |
π Want to learn more?
Check out Starlightβs docs, read the Astro documentation, or jump into the Astro Discord server.