mirror of
https://github.com/withastro/astro.git
synced 2024-12-16 21:46:22 -05:00
29 lines
862 B
Markdown
29 lines
862 B
Markdown
|
# Astro Starter Kit: Docs Site
|
||
|
|
|
||
|
|
```
|
||
|
|
npm init astro --template docs
|
||
|
|
```
|
||
|
|
|
||
|
|
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
||
|
|
|
||
|
|
Features:
|
||
|
|
|
||
|
|
- ✅ CSS Grid Layout
|
||
|
|
- ✅ Full Markdown support
|
||
|
|
- ✅ Automatic header navigation sidebar
|
||
|
|
- ✅ Dark mode enabled by default
|
||
|
|
|
||
|
|
## 🧞 Commands
|
||
|
|
|
||
|
|
All commands are run from the root of the project, from a terminal:
|
||
|
|
|
||
|
|
| Command | Action |
|
||
|
|
|:----------------|:--------------------------------------------|
|
||
|
|
| `npm install` | Installs dependencies |
|
||
|
|
| `npm run start` | Starts local dev server at `localhost:3000` |
|
||
|
|
| `npm run build` | Build your production site to `./dist/` |
|
||
|
|
|
||
|
|
## 👀 Want to learn more?
|
||
|
|
|
||
|
|
Feel free to check [our documentation](https://github.com/snowpackjs/astro) or jump into our [Discord server](https://astro.build/chat).
|