diff options
Diffstat (limited to 'examples/docs/README.md')
| -rw-r--r-- | examples/docs/README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/examples/docs/README.md b/examples/docs/README.md new file mode 100644 index 000000000..22f4f40a9 --- /dev/null +++ b/examples/docs/README.md @@ -0,0 +1,28 @@ +# 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). |