docs: quickstart.md

This commit is contained in:
2026-04-01 12:34:05 +02:00
parent 7fe204f9f9
commit 00f4bbb5f0
3 changed files with 35 additions and 2 deletions

View File

@@ -2,6 +2,8 @@
![the greatest drawing of a blobfish in the world](blobfish.bmp) ![the greatest drawing of a blobfish in the world](blobfish.bmp)
![mine turtle hello](hello.mp3) ![mine turtle hello](hello.mp3)
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus malesuada lacus eu ligula semper pharetra. Cras viverra volutpat massa nec sagittis. Aliquam fringilla quam ut tincidunt ultricies. Aliquam erat volutpat. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed id sagittis nisi. Aenean vitae urna justo. Vivamus dictum eros ac mi convallis, blandit hendrerit nunc sagittis. Mauris feugiat neque quis justo molestie, vel pulvinar diam faucibus. Ut tempus magna sit amet ex pharetra mollis. Ut elementum metus metus, id consectetur est tempor eget. Proin sed nibh tincidunt, porttitor elit non, blandit ligula. Ut condimentum accumsan lobortis. Nullam nec tempus leo, sit amet iaculis erat. Donec rutrum, orci in elementum varius, nisl elit rutrum nunc, in lacinia lorem enim non enim. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus malesuada lacus eu ligula semper pharetra. Cras viverra volutpat massa nec sagittis. Aliquam fringilla quam ut tincidunt ultricies. Aliquam erat volutpat. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed id sagittis nisi. Aenean vitae urna justo. Vivamus dictum eros ac mi convallis, blandit hendrerit nunc sagittis. Mauris feugiat neque quis justo molestie, vel pulvinar diam faucibus. Ut tempus magna sit amet ex pharetra mollis. Ut elementum metus metus, id consectetur est tempor eget. Proin sed nibh tincidunt, porttitor elit non, blandit ligula. Ut condimentum accumsan lobortis. Nullam nec tempus leo, sit amet iaculis erat. Donec rutrum, orci in elementum varius, nisl elit rutrum nunc, in lacinia lorem enim non enim.

32
site/docs/quickstart.md Normal file
View 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)

View File

@@ -41,5 +41,4 @@ It's meant to be a static site generator, like _[kew](https://github.com/uint23/
*** ***
> [!WARNING] ## [Quickstart guide](/docs/quickstart.html)
> The base that all of this is built upon was coded at night, while sleepy and a bit sick, and after walking for about 4 hours around a forest, so...