4 Commits

Author SHA1 Message Date
21dc56aa6d docs: markdown
All checks were successful
Release Standalone Builder / build (release) Successful in 32s
Release Standalone Builder / publish-aur (release) Successful in 35s
Release Standalone Builder / publish-homebrew (release) Successful in 6s
2026-04-01 15:39:54 +02:00
7df5daaa6c branding: table styles 2026-04-01 15:24:37 +02:00
4f74dd5fe0 fix: !! 2026-04-01 15:09:24 +02:00
0751849492 docs: theming 2026-04-01 15:04:57 +02:00
21 changed files with 294 additions and 7 deletions

View File

@@ -375,6 +375,13 @@ function rewrite_img_tags(line, out, rest, tag, src, alt, force_inline_tag, e
} else if (is_image_ext(ext_of(src)) && force_inline_tag == "") {
# Preserve hand-written <img> attributes (style/class/etc) for normal images.
repl = tag
} else if (force_inline_tag != "" && !is_global_url(src) && is_inline_text_ext(ext_of(src))) {
repl = render_code_include(src, 1)
if (repl != "") {
repl = "<pre><code>" repl "</code></pre>"
} else {
repl = render_embed(src, alt, (alt != ""), 1)
}
} else {
repl = render_embed(src, alt, (alt != ""), (force_inline_tag != ""))
}
@@ -399,7 +406,12 @@ function rewrite_double_bang_with_parens(line, out, rest, token, inside, src,
src = substr(inside, sep + 2)
sub(/\)$/, "", src)
repl = render_embed(src, alt, (alt != ""), 1)
repl = render_code_include(src, 1)
if (repl != "") {
repl = "<pre><code>" repl "</code></pre>"
} else {
repl = render_embed(src, alt, (alt != ""), 1)
}
out = out pre repl
rest = post
}
@@ -416,7 +428,12 @@ function rewrite_double_bang_bare(line, out, rest, token, src, pre, post, rep
src = token
sub(/^!!\[/, "", src)
sub(/\]$/, "", src)
repl = render_embed(src, "", 0, 1)
repl = render_code_include(src, 1)
if (repl != "") {
repl = "<pre><code>" repl "</code></pre>"
} else {
repl = render_embed(src, "", 0, 1)
}
out = out pre repl
rest = post
}
@@ -576,6 +593,75 @@ function restore_plain_markers(line) {
return line
}
function break_code_double_bang(line, out, rest, pstart, pend, code_content, token, pre, post, inside, sep, src, alt, repl) {
out = ""
rest = line
while (1) {
pstart = index(rest, "<code>")
if (pstart == 0) {
out = out rest
break
}
out = out substr(rest, 1, pstart - 1)
rest = substr(rest, pstart)
pend = index(substr(rest, 7), "</code>")
if (pend == 0) {
out = out rest
break
}
pend = pend + 6
code_content = substr(rest, 7, pend - 7)
rest = substr(rest, pend + 7)
if (match(code_content, /!!\[[^\]]*\]\([^)]*\)/)) {
token = substr(code_content, RSTART, RLENGTH)
pre = substr(code_content, 1, RSTART - 1)
post = substr(code_content, RSTART + RLENGTH)
inside = token
sub(/^!!\[/, "", inside)
sep = index(inside, "](")
alt = substr(inside, 1, sep - 1)
src = substr(inside, sep + 2)
sub(/\)$/, "", src)
repl = render_code_include(src, 1)
if (repl != "") {
repl = "<pre><code>" repl "</code></pre>"
} else {
repl = render_embed(src, alt, (alt != ""), 1)
}
if (repl == "") {
out = out "<code>" code_content "</code>"
} else {
if (pre != "") out = out "<code>" pre "</code>"
out = out repl
if (post != "") out = out "<code>" post "</code>"
}
} else if (match(code_content, /!!\[[^\]]+\]/)) {
token = substr(code_content, RSTART, RLENGTH)
pre = substr(code_content, 1, RSTART - 1)
post = substr(code_content, RSTART + RLENGTH)
src = token
sub(/^!!\[/, "", src)
sub(/\]$/, "", src)
repl = render_code_include(src, 1)
if (repl != "") {
repl = "<pre><code>" repl "</code></pre>"
} else {
repl = render_embed(src, "", 0, 1)
}
if (repl == "") {
out = out "<code>" code_content "</code>"
} else {
if (pre != "") out = out "<code>" pre "</code>"
out = out repl
if (post != "") out = out "<code>" post "</code>"
}
} else {
out = out "<code>" code_content "</code>"
}
}
return out
}
BEGIN {
input_dir = dirname_of(input_file)
in_pre_code = 0
@@ -601,6 +687,9 @@ BEGIN {
line = apply_td_vertical_align(line)
line = restore_plain_markers(line)
if (!(in_pre_code || start_pre)) {
line = break_code_double_bang(line)
}
print line
if (start_pre && !end_pre) {

View File

@@ -67,6 +67,17 @@ function mask(s, t) {
if (plen >= 2 && substr(content, 1, 1) == " " && substr(content, length(content), 1) == " ") {
content = substr(content, 2, length(content) - 2)
}
if (content ~ /!!\[/) {
_rb_test = content
gsub(/!!\[[^\]]*\]\([^)]*\)/, "", _rb_test)
gsub(/!!\[[^\]]+\]/, "", _rb_test)
gsub(/[[:space:]]+/, "", _rb_test)
if (_rb_test == "") {
out = out content
p = pstart + plen + mpos + plen - 1
continue
}
}
out = out "<code>" mask(content) "</code>"
p = pstart + plen + mpos + plen - 1
} else {

View File

@@ -50,7 +50,7 @@ END {
in_pre = 0
i = 1
while (i <= count) {
if (lines[i] ~ /^<pre><code>/) {
if (lines[i] ~ /^<pre><code/) {
in_pre = 1
print lines[i]
i++

View File

@@ -43,7 +43,7 @@ search_in_header = false
include_cw_pages_in_search = false
```
- `title` - site title
- `style` - style file name from `./styles` (without `.css`)
- `style` - style name from the built-in `styles/` directory. See [Theming](theming.md)
- `lang` - document language, used for the `<html lang="...">` attribute (default: "en")
- `draft_by_default` - default value for the `draft` frontmatter field in new posts created (default: false)
- `dir_indexes` - generate directory index pages when missing `index.md`

View File

@@ -13,6 +13,14 @@ title = "Embeds"
If you want to **force** a file to be inlined, use `\!![]` instead of `\![]`
## Reality-Breaking Embeds
`\!![link]` and `\!![alt](link)` work even inside inline code blocks. If the content between backticks consists only of `\!![]` embeds, the embed triggers and the content is inlined instead of being rendered as code.
```
`!![/file.sh]`
```
## Typed Embeds
Force specific output regardless of extension:

View File

@@ -39,3 +39,82 @@ This renders as `<dl><dt>Term</dt><dd>Definition</dd></dl>`. Multiple definition
## 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.
## Pipe Tables
Tables use the GitHub-style syntax:
```md
| Header 1 | Header 2 |
|---|---|
| cell 1 | cell 2 |
| cell 3 | cell 4 |
```
Column alignment is set with colons in the separator:
```md
| Left | Center | Right |
|:---|:---:|---:|
| a | b | c |
```
Tables can drop the header row and with a separator:
```md
|---|---|
| a | b |
```
## Blockquotes
Standard Markdown blockquote syntax using `>`:
```md
> This is a blockquote.
> It can span multiple lines.
```
### Admonitions
Blockquotes that start with a type tag become styled admonition blocks. Five built-in types are supported: `NOTE`, `TIP`, `IMPORTANT`, `WARNING`, `CAUTION`.
```md
> [!NOTE]
> This is a note admonition.
```
Custom admonition types can be added via the `custom_admonitions` config option in `site.conf`.
## Task Lists
GFM-style task lists are supported inside **both** ordered and unordered lists:
```md
- [ ] Unchecked item
- [x] Checked item
- Normal item
1. [ ] Unchecked item
2. [x] Checked item
3. Normal item
```
## Reference Links
Markdown reference-style links and images are supported:
```md
[link text][ref]
[ref]: https://example.com "Optional title"
![alt text][img-ref]
[img-ref]: /image.png "Optional title"
```
## Plain Text Blocks
Content inside `<plain>...</plain>` tags is rendered without any Markdown processing
## MFM Font Syntax
Misskey-style font syntax is supported for inline font family changes:
- `$[font.serif text]` - serif font
- `$[font.mono text]` - monospace font
- `$[font.sans text]` - sans-serif font

60
site/docs/theming.md Normal file
View File

@@ -0,0 +1,60 @@
---
title = "Theming"
---
# Theming
*kewt* has a few colour palettes built-in. Set the `style` option in `site.conf` to a theme name to apply it.
## Built-in Themes
| Theme | `style` value | Dark/Light |
|---|---|---|
| Kewt (default) | `kewt` | Light |
| Kewt Light | `kewt-light` | Light |
| Nord | `nord` | Dark |
| Nord Light | `nord-light` | Light |
| Monokai | `mono` | Dark |
| Monokai Light | `mono-light` | Light |
| One Dark | `onedark` | Dark |
| One Light | `onelight` | Light |
| Rose Pine | `rosepine` | Dark |
| Rose Pine Light | `rosepine-light` | Light |
| Solarized | `solarized` | Light |
| Solarized Dark | `solarized-dark` | Dark |
```conf
style = "kewt-light"
```
## How It Works
Each theme is a `.root.css` file containing a `:root` block with CSS custom properties. At build time, *kewt* merges the theme's variables with the base `kewt.css` stylesheet. The base `:root` block is stripped out and replaced with the theme's variables.
## Style Resolution
*kewt* resolves styles in this priority order (highest wins):
1. `site/styles.css` - a full custom stylesheet in your site directory. Overrides everything.
2. `site/styles.root.css` - custom `:root` variables merged with the built-in `kewt.css` base.
3. built-in `<style>.css` - a full stylesheet matching the `style` config value.
4. built-in `<style>.root.css` - `:root` variables merged with `kewt.css`.
If none of these exist, the unmodified `kewt.css` is used
## Custom Themes
To create a custom colour theme, place a `styles.root.css` file in your site directory. The file should contain only a `:root` block with the CSS variables you want to override:
```css
:root {
--bg: #1a1b26;
--fg: #c0caf5;
--fg-link: #7aa2f7;
--fg-heading: #c0caf5;
--code-bg: #24283b;
}
```
Any variables not overridden will fall back to the defaults in `kewt.css`. The `:root` block in the base stylesheet is automatically removed to prevent conflicts.
## Per-Directory Styles
Subdirectories can have their own `styles.css` or `styles.root.css` that apply only to pages in that directory. Per-directory styles follow the same priority.

View File

@@ -20,4 +20,6 @@ kewt --serve [port]
- `--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.
- `--clean` cleans the output directory before building (default behavior).
- `--no-clean` does not clean the output directory before building. Useful with `--watch` to avoid clearing output on every rebuild.
- `--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`.

View File

@@ -9,4 +9,4 @@ Told you
Probably should've mentioned the catgirl too
| --- | --- |
| ```![/styles.css]``` | <img style="vertical-align: top;" src="catgirl.jpg"> |
| ```!![/styles.css]``` | <img style="vertical-align: top;" src="catgirl.jpg"> |

View File

@@ -23,4 +23,5 @@
--adm-warning-border: #b8860b;
--adm-caution-bg: #f5dddd;
--adm-caution-border: #c44569;
--thead-bg: #e8dffa;
}

View File

@@ -23,6 +23,7 @@
--adm-warning-border: #ffe2bd;
--adm-caution-bg: #662d43;
--adm-caution-border: #ffc4d5;
--thead-bg: #3d2d5c;
}
body {
@@ -271,6 +272,32 @@ hr {
border-top: 1px solid var(--code-border);
}
table {
border-collapse: collapse;
margin: 20px 0;
width: 100%;
}
thead {
border-bottom: 2px solid var(--code-border);
background: var(--thead-bg);
}
th {
font-weight: bold;
text-align: left;
padding: 8px 12px;
}
td {
padding: 8px 12px;
border-top: 1px solid var(--code-border);
}
tr:nth-child(even) {
background: var(--bg-deep);
}
.nav-toggle,
.nav-toggle-label {
display: none;
@@ -303,7 +330,7 @@ hr {
margin: 0 20px 20px 20px;
}
.nav-toggle:checked~#side-bar {
.nav-toggle:checked ~ #side-bar {
display: block;
}
@@ -536,4 +563,4 @@ hr {
flex: 1;
width: auto;
}
}
}

View File

@@ -23,4 +23,5 @@
--adm-warning-border: #aaaa78;
--adm-caution-bg: #eee0e0;
--adm-caution-border: #aa8888;
--thead-bg: #e8e8e8;
}

View File

@@ -23,4 +23,5 @@
--adm-warning-border: #8a8a5a;
--adm-caution-bg: #2e1a1a;
--adm-caution-border: #8a5a5a;
--thead-bg: #111111;
}

View File

@@ -23,4 +23,5 @@
--adm-warning-border: #ebcb8b;
--adm-caution-bg: #eddcdc;
--adm-caution-border: #bf616a;
--thead-bg: #d8dee9;
}

View File

@@ -23,4 +23,5 @@
--adm-warning-border: #ebcb8b;
--adm-caution-bg: #3b3840;
--adm-caution-border: #bf616a;
--thead-bg: #3b4252;
}

View File

@@ -23,4 +23,5 @@
--adm-warning-border: #e5c07b;
--adm-caution-bg: #3a2c2e;
--adm-caution-border: #e06c75;
--thead-bg: #21252b;
}

View File

@@ -23,4 +23,5 @@
--adm-warning-border: #986801;
--adm-caution-bg: #fae8e8;
--adm-caution-border: #e45649;
--thead-bg: #eaeaeb;
}

View File

@@ -23,4 +23,5 @@
--adm-warning-border: #ea9d34;
--adm-caution-bg: #f5e5e8;
--adm-caution-border: #b4637a;
--thead-bg: #f2e9e1;
}

View File

@@ -23,4 +23,5 @@
--adm-warning-border: #f6c177;
--adm-caution-bg: #2a1f22;
--adm-caution-border: #eb6f92;
--thead-bg: #1f1d2e;
}

View File

@@ -23,4 +23,5 @@
--adm-warning-border: #b58900;
--adm-caution-bg: #360a07;
--adm-caution-border: #cb4b16;
--thead-bg: #073642;
}

View File

@@ -23,4 +23,5 @@
--adm-warning-border: #b58900;
--adm-caution-bg: #fde8e8;
--adm-caution-border: #dc322f;
--thead-bg: #eee8d5;
}