mirror of
https://github.com/tauri-apps/tauri-docs.git
synced 2026-01-31 00:35:16 +01:00
341b49cd68
* add prettier Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * add prettier script Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * add prettier configs Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * add git modules to ignore Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * ignore formatting autogenerated references Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * format Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * add format workflow for testing Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * set package manager Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * valid package manager? Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * test applying formatting Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * [ci] format * update action target branch Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * line break Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> --------- Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> Co-authored-by: lorenzolewis <lorenzolewis@users.noreply.github.com>
- Tutorials: Blog post
- How-to Guides:
/src/content/docs/v2/guides - Explanation: Blog post
- Reference:
/src/content/docs/v2/reference
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:
| Command | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:3000 |
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 |