docs: massive doc update
All checks were successful
All checks were successful
This commit is contained in:
69
site/docs/configuration.md
Normal file
69
site/docs/configuration.md
Normal file
@@ -0,0 +1,69 @@
|
||||
---
|
||||
title = "Configuration"
|
||||
---
|
||||
# Configuration
|
||||
|
||||
## site.conf
|
||||
|
||||
```conf
|
||||
title = "kewt"
|
||||
style = "kewt"
|
||||
dir_indexes = true
|
||||
single_file_index = true
|
||||
flatten = false
|
||||
order = ""
|
||||
home_name = "Home"
|
||||
show_home_in_nav = true
|
||||
nav_links = ""
|
||||
nav_extra = ""
|
||||
footer = "made with <a href=\"https://kewt.krzak.org\">kewt</a>"
|
||||
logo = ""
|
||||
display_logo = false
|
||||
display_title = true
|
||||
logo_as_favicon = true
|
||||
favicon = ""
|
||||
generate_page_title = true
|
||||
error_page = "not_found.html"
|
||||
versioning = false
|
||||
enable_header_links = true
|
||||
base_url = ""
|
||||
generate_feed = false
|
||||
feed_file = "rss.xml"
|
||||
posts_dir = ""
|
||||
posts_per_page = 12
|
||||
custom_admonitions = ""
|
||||
cw_hide_url = true
|
||||
```
|
||||
- `title` - site title
|
||||
- `style` - style file name from `./styles` (without `.css`)
|
||||
- `dir_indexes` - generate directory index pages when missing `index.md`
|
||||
- `single_file_index` - if a directory has one markdown file and no `index.md`, use that file as `index.html`
|
||||
- `flatten` - flatten sidebar directory levels
|
||||
- `order` - comma separated file/directory name list to order the sidebar (alphabetical by default)
|
||||
- `home_name` - text for the home link in navigation (default: "Home")
|
||||
- `show_home_in_nav` - show home link in navigation (default: true)
|
||||
- `nav_links` - comma separated extra nav links, as bare URLs or Markdown links like `[Label](https://example.com)`
|
||||
- `nav_extra` - raw HTML appended inside the `<nav>` after the generated link list
|
||||
- `footer` - footer html/text shown at the bottom of pages
|
||||
- `logo` - logo image path (used in header if enabled)
|
||||
- `display_logo` - show logo in header
|
||||
- `display_title` - show title text in header
|
||||
- `logo_as_favicon` - use `logo` as favicon
|
||||
- `favicon` - explicit favicon path (used when `logo_as_favicon` is false or no logo is set)
|
||||
- `generate_page_title` - automatically generate title text from the first markdown heading or filename (default: true)
|
||||
- `error_page` - filename for the generated 404 error page (default: "not_found.html", empty to disable)
|
||||
- `versioning` - append a version query parameter (`?v=timestamp`) to css asset urls to bypass cache (default: false)
|
||||
- `base_url` - absolute URL of the site, used for sitemap and RSS feed generation
|
||||
- `generate_feed` - enable RSS feed generation (requires `base_url`)
|
||||
- `feed_file` - filename for the generated RSS feed (default: "rss.xml")
|
||||
- `posts_dir` - directory name containing posts (e.g., "posts"). Enables reverse-chronological sorting, title headings in indexes, and automatic backlinks.
|
||||
- `posts_per_page` - number of posts per page in paginated post indexes (default: 12). Set to 0 to disable pagination.
|
||||
- `enable_header_links` - turns markdown section headings into clickable anchor links (default: true)
|
||||
- `custom_admonitions` - comma separated list of custom admonitions
|
||||
- `cw_hide_url` - embeds non-breaking JS to replace the URL in the browser bar on content warning pages (default: true)
|
||||
|
||||
## Dot Files
|
||||
|
||||
- `.kewtignore` - files/directories to ignore completely. If the file is empty, the whole directory gets ignored.
|
||||
- `.kewthide` - files/directories to hide from navigation but still process. Same empty-file rules as `.kewtignore`.
|
||||
- `.kewtpreserve` - files/directories to copy as-is without converting markdown to HTML. Same empty-file rules again.
|
||||
24
site/docs/embeds.md
Normal file
24
site/docs/embeds.md
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title = "Embeds"
|
||||
---
|
||||
# Embeds
|
||||
|
||||
- `\![link]`:
|
||||
- local image/audio/video files are embedded as media tags
|
||||
- local text/code files are inlined directly
|
||||
- global image/audio/video links are embedded as media tags
|
||||
- other global links are embedded as `<iframe>`
|
||||
- `\` works the same, with `alt` used for images
|
||||
- `\!![link]` and `\!` force inline local file contents
|
||||
|
||||
If you want to **force** a file to be inlined, use `\!![]` instead of `\![]`
|
||||
|
||||
## Typed Embeds
|
||||
|
||||
Force specific output regardless of extension:
|
||||
|
||||
- `\!i[link]` or `\!i[alt](link)` - **I**mage
|
||||
- `\!v[link]` - **V**ideo
|
||||
- `\!a[link]` - **A**udio
|
||||
- `\!f[link]` - I**f**rame
|
||||
- `\!e[link]` - Inline/**e**mbed text/code file directly
|
||||
20
site/docs/frontmatter.md
Normal file
20
site/docs/frontmatter.md
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title = "Frontmatter"
|
||||
---
|
||||
# Frontmatter
|
||||
|
||||
You can set metadata for a page using a `site.conf`-style frontmatter block at the very top of `.md` files:
|
||||
|
||||
```conf
|
||||
---
|
||||
title = "Custom Page Title"
|
||||
date = "2026-03-23 11:32"
|
||||
draft = false
|
||||
description = "A short page summary"
|
||||
---
|
||||
```
|
||||
- `title` - overrides the page title, post name in index links, and RSS `<title>`.
|
||||
- `date` - overrides the post date and time. Supports `YYYY-MM-DD` and `YYYY-MM-DD HH:MM` (or `HH-MM`).
|
||||
- `draft` - if `true`, the file is excluded from HTML generation.
|
||||
- `description` - page description, used for Open Graph `og:description` meta tag.
|
||||
- `content_warning` - if set, creates an interstitial warning page that the user must click through. If set to `true` uses a generic warning, otherwise uses your string.
|
||||
6
site/docs/index.md
Normal file
6
site/docs/index.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title = "Documentation"
|
||||
---
|
||||
# Documentation
|
||||
|
||||
{{LIST}}
|
||||
45
site/docs/installation.md
Normal file
45
site/docs/installation.md
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title = "Installation"
|
||||
---
|
||||
# Installation
|
||||
|
||||
## Standalone
|
||||
|
||||
```sh
|
||||
curl -L -o kewt https://git.krzak.org/N0VA/kewt/releases/download/latest/kewt
|
||||
chmod +x kewt
|
||||
```
|
||||
## From source
|
||||
|
||||
```sh
|
||||
git clone https://git.krzak.org/N0VA/kewt.git
|
||||
cd kewt
|
||||
```
|
||||
### Building
|
||||
|
||||
```sh
|
||||
make
|
||||
```
|
||||
### Installing
|
||||
|
||||
```sh
|
||||
sudo make install
|
||||
```
|
||||
## Package Managers
|
||||
|
||||
### AUR
|
||||
|
||||
- [kewt-bin](https://aur.archlinux.org/packages/kewt-bin) - prebuilt standalone binary from the latest release
|
||||
- [kewt-git](https://aur.archlinux.org/packages/kewt-git) - built from the latest git source
|
||||
|
||||
### Homebrew
|
||||
|
||||
```sh
|
||||
brew tap n0va-bot/tap
|
||||
brew install kewt
|
||||
```
|
||||
### bpkg
|
||||
|
||||
```sh
|
||||
bpkg install n0va-bot/kewt
|
||||
```
|
||||
41
site/docs/markdown.md
Normal file
41
site/docs/markdown.md
Normal file
@@ -0,0 +1,41 @@
|
||||
---
|
||||
title = "Markdown Extensions"
|
||||
---
|
||||
# Markdown Extensions
|
||||
|
||||
## Directory Index Customisation
|
||||
|
||||
By default, directories without an `index.md` get an auto-generated index page listing their contents.
|
||||
|
||||
If you create your own `index.md` in a directory, you can still include the auto-generated file list by using the `{{LIST}}` placeholder:
|
||||
|
||||
```md
|
||||
# Blog
|
||||
|
||||
This is my blog. The posts are below. The top-most one is the most recent.
|
||||
|
||||
{{LIST}}
|
||||
```
|
||||
The `{{LIST}}` placeholder is replaced with the autogenerated file list.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
`{{TOC}}` auto-generates a nested heading list with clickable anchors.
|
||||
|
||||
## Footnotes
|
||||
|
||||
Full support for `[^id]` footnotes and `[^id]: text` definitions. They render as a numbered `<section>` at the bottom of the page.
|
||||
|
||||
## Definition Lists
|
||||
|
||||
Definition lists use the standard syntax:
|
||||
|
||||
```md
|
||||
Term
|
||||
: Definition
|
||||
```
|
||||
This renders as `<dl><dt>Term</dt><dd>Definition</dd></dl>`. Multiple definitions per term are supported.
|
||||
|
||||
## Emoji Shortcodes
|
||||
|
||||
Standard GitHub/MkDocs emoji shortcodes like `:smile:`, `:fire:`, `:rocket:` are automatically replaced with their Unicode emoji equivalents. Shortcodes inside code blocks are left as-is.
|
||||
15
site/docs/templates.md
Normal file
15
site/docs/templates.md
Normal file
@@ -0,0 +1,15 @@
|
||||
---
|
||||
title = "Templates"
|
||||
---
|
||||
# Templates
|
||||
|
||||
When customizing `template.html`, the placeholders available are:
|
||||
- `{{CONTENT}}` - the generated content
|
||||
- `{{TITLE}}` - the generated title
|
||||
- `{{NAV}}` - the generated navigation
|
||||
- `{{FOOTER}}` - the configured footer
|
||||
- `{{VERSION}}` - the cache-busting string from `versioning = true` (e.g. `?v=12345678`). Safe to use even if versioning is **disabled** (it will be empty).
|
||||
- `{{CSS}}` - the configured CSS file path
|
||||
- `{{LANG}}` - the configured document language
|
||||
- `{{HEAD_EXTRA}}` - meta-tags
|
||||
- `{{HEADER_BRAND}}` - header rendering the name and/or logo
|
||||
23
site/docs/usage.md
Normal file
23
site/docs/usage.md
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
title = "Usage"
|
||||
---
|
||||
# Usage
|
||||
|
||||
```sh
|
||||
kewt --help
|
||||
kewt --version
|
||||
kewt --new [title]
|
||||
kewt --post [title]
|
||||
kewt --generate-template [path]
|
||||
kewt --update [dir]
|
||||
kewt --from <src> --to <out>
|
||||
kewt [src] [out]
|
||||
kewt --watch
|
||||
kewt --serve [port]
|
||||
```
|
||||
- `--new [title]` creates a new site directory with a default `site.conf`, `template.html`, and `index.md`.
|
||||
- `--post [title]` creates a new markdown file in the configured `posts_dir` with the current date/time as the filename and default frontmatter.
|
||||
- `--generate-template [path]` writes the default `template.html` to the given path (defaults to `template.html` in the current directory).
|
||||
- `--update [dir]` adds any missing keys to `site.conf` and checks `template.html` against the latest default.
|
||||
- `--watch` (`-w`) watches for file changes in the source directory and rebuilds automatically.
|
||||
- `--serve` (`-s`) starts a local HTTP server (python3 or busybox) in the output directory after building. Use with the port number to specify the port. Composable with `--watch`.
|
||||
Reference in New Issue
Block a user