mirror of
https://github.com/wailsapp/wails.git
synced 2025-05-03 06:01:52 +08:00
b6c8d9a90a
* init docs * add few categories * add more * update home * add blog * update favicon * fix few links and * untouch * untouch more * add some icons * add icons * move ggetting started at the top and collapse the rest * actually collapse * format * remove includes * more format * remove includes * move assets * add i18n * fix i18n * formatting * order * Prevent sidebar from making the page shake during load * Prevent sidebar from making the page shake during load * organize docs * fix link * expand a bit * add credits page * update all contributors file * remove underlines * add alternative * use html * lets get the first success build * add latest entry * remove example file * fix examples * more fixes * fix grammar * grammar * remove dupes * fix link * grammar * typo * typo * typo * Logo update. Minor changes. * update changelog * update changelog * rabbit is right --------- Co-authored-by: Lea Anthony <lea.anthony@gmail.com>
2.6 KiB
2.6 KiB
Starlight Starter Kit: Basics
npm create astro@latest -- --template starlight
🧑🚀 Seasoned astronaut? Delete this file. Have fun!
🚀 Project Structure
Inside of your Astro + Starlight project, you'll see 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.
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: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.