Files
archived-tauri-docs/README.md
2023-07-27 23:16:17 +02:00

1.2 KiB

docs2

  • 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