astro/examples/docs/README.md

29 lines
865 B
Markdown
Raw Permalink Normal View History

# 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 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).