docs: quickstart.md
This commit is contained in:
32
site/docs/quickstart.md
Normal file
32
site/docs/quickstart.md
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
title = "Quickstart"
|
||||
---
|
||||
# Quickstart
|
||||
|
||||
## Creating a site
|
||||
|
||||
```sh
|
||||
kewt --new mysite
|
||||
cd mysite
|
||||
```
|
||||
This creates a directory with a `site.conf`, `template.html`, and `index.md`.
|
||||
|
||||
## Writing content
|
||||
|
||||
Edit `index.md` (or any `.md` file) and just write markdown as usual. Files in subdirectories are added to the navigation automatically.
|
||||
|
||||
## Building
|
||||
|
||||
```sh
|
||||
kewt src out # Replace with the directories you want
|
||||
```
|
||||
Reads from `src` and writes static HTML to `out`.
|
||||
|
||||
## Previewing
|
||||
|
||||
```sh
|
||||
kewt --serve
|
||||
```
|
||||
Builds the site and starts a local HTTP server. Use `--watch` with `--serve` to rebuild automatically on file changes.
|
||||
|
||||
## That's it, if you want to do anything more, look at [the documentation](/docs)
|
||||
Reference in New Issue
Block a user