Structure
Tabs
Every file content/pages/*.md is one tab in the top bar.
The tab name is the file name without .md. A translation is a file name.cs.md or name.en.md and is shown according to the selected language.
- user tabs are on the left, their order is set by
[tabs] order - hidden tabs (
[tabs] hidden) are reachable via/<name> - the first user tab is at
/ - create a new file on the settings page
- a link to another tab is a plain link to
/<name>:
[documentation](/documentation)
Columns
A # line starts a new column, --- a new row of columns. This whole page is built that way.
Card in the 1st column
--- makes a line break. This column is alone here, so its content spans the full width.
#
default column width (#) is 1/x
x=number of columns
#+
you can add a + or - mark to the column
#+ equals 1.5x the default column
#-
#- is the opposite, 0.5x
#
1x again for comparison
#++
2x + for 1.75x
#--
0.25x
custom relative width
You can also set the column width with a number after #
Whole numbers and decimals with a dot or comma both work.
#1.2
i.e. 1.2x
#1.8
i.e. 1.8x
#1.11
i.e. 1.11x
#0.35
i.e. 0.35x
#3
i.e. 3x
fixed width
A column can also have a fixed width in px, em, rem or %, e.g. #120px. The other columns in the row share the remaining space.
120px
120px fixed
rest
computed width
500px
500px fixed
200px
200px fixed
100px
100px fixed
10em
10em fixed
10rem
10rem fixed
10%
10% fixed
rest
computed width
| syntax | result |
|---|---|
# |
column |
#+ |
column 1.5× wider |
#++ |
column 1.75× wider |
#- |
narrow column, half width |
#-- |
very narrow column, quarter width |
#1.2 · #0,8 |
custom width ratio (decimal point or comma) |
#120px · #12em · #30% |
fixed width, the other columns in the row share the rest; percentages include the gaps, so #25% #25% #50% fill the row exactly |
--- |
new row of columns (the line right before #); a lone # in a row is a full-width band |
##. heading |
column heading without a frame, see Plain card |
- the text after
#only helps you find your way in the file, it is not shown on the page - widths are relative: the numbers in a row set the ratio,
#++next to#-is 3.5× wider; narrow columns suit quick links or service status - a column needs at least its number ×
[layout] column_min_width; what does not fit wraps to the next row and stretches - the gap between
---rows is the same as between columns ([layout] row_gap); a/line between---and#adds more - a
---not followed by#stays a horizontal line in the card - number of columns: window width, or
[layout] columns_fixed #inside a code block is ignored
# Dev
## Repos
…
#+ Wide column
## Servers
…
#- Narrow column
## Quick links
…
---
# Full-width band
## News
…
Cards
## Title creates a framed card, like every box on this page.
🧱 Cards and headings
Card
Every ## starts a new card with a frame; everything up to the next ## or # belongs to it.
##. instead of ## is a card without a frame, e.g. a column heading (at the top).
Subheading
### structures the content inside a card.
small caption
#### is a muted caption,
even smaller
and the smallest
Stretched card
Another # = another column next to it.
{.fill} after the heading stretches the card to the height of the tallest column.
Space above a card
A / line between cards or columns adds a blank line, // two.
Card without a heading: a bare ## is enough.
Foldable card
##+ instead of ##: clicking the heading folds the card, ##- starts folded. The browser remembers it.
Everything up to the next ## or # belongs to the card.
Content before the first ## in a column forms a card without a title, and so does a bare ## without text.
## Title {.fill} stretches the card to the height of the tallest column in the row, so neighbouring cards end at the same level (the Author card on the settings page).
## Repos
- [GitHub](https://github.com)
Plain card
##. instead of ## draws a card without a frame and background, like the yellow row headings on this page.
🧱 Cards and headings
Card
Every ## starts a new card with a frame; everything up to the next ## or # belongs to it.
##. instead of ## is a card without a frame, e.g. a column heading (at the top).
Subheading
### structures the content inside a card.
small caption
#### is a muted caption,
even smaller
and the smallest
Second column
Another # = another column next to it.
Space above a card
A / line between cards or columns adds a blank line, // two.
Card without a heading: a bare ## is enough.
Handy for naming a column, but it can have content too, e.g. text right on the page. A bare ##. without text = content without a frame or heading.
code in any heading has no frame of its own, only its colour stays.
# Structure
##. `Structure`
## Tabs
…
Editable cards
##* instead of ## marks a card you can edit right on the page, without opening the editor.
📝 Note
Between {{note}} and {{/note}} there is a field you type into right on the page.
It saves itself into the md file. Markdown is not rendered in it, it is plain text.
✎ Editable card
This week
Mon tennis
Wed choir
Fri cinema
Sun trip
Mon back to work
##* instead of ## adds ✎ to the card. You edit it right on the page, without the editor, and only this card is saved.
Handy for small ongoing things: lists, tables, short texts.
- on hover a ✎ appears at the top right, a click opens the card's markdown in place
- Ctrl+Enter saves, Esc cancels; smart typing and editor shortcuts work
- only this card is saved, the rest of the file stays unchanged
- if the card was changed elsewhere in the meantime, saving is refused and nothing is overwritten
- the title and new cards are changed in the editor; works only for your tabs and with the editor password
##* Shopping list
- milk
- bread
Foldable cards
A click on the heading folds the card and it stays folded next time. Try it on this card.
🧱 Cards and headings
Card
Every ## starts a new card with a frame; everything up to the next ## or # belongs to it.
##. instead of ## is a card without a frame, e.g. a column heading (at the top).
Subheading
### structures the content inside a card.
small caption
#### is a muted caption,
even smaller
and the smallest
Stretched card
Another # = another column next to it.
{.fill} after the heading stretches the card to the height of the tallest column.
Space above a card
A / line between cards or columns adds a blank line, // two.
Card without a heading: a bare ## is enough.
Foldable card
##+ instead of ##: clicking the heading folds the card, ##- starts folded. The browser remembers it.
##- instead of ## is a card folded from the start, ##+ unfolded but foldable. A click on the heading (or Enter on it) toggles it. The browser remembers the state per page and card, nothing is written to the file. Combines with {.fill} or {.mobile}.
##- Archive
- old links
##+ This week
- …
Subheadings
### structures the content inside a card.
🧱 Cards and headings
Card
Every ## starts a new card with a frame; everything up to the next ## or # belongs to it.
Subheading
### structures the content inside a card.
small caption
#### is a muted caption,
even smaller
and the smallest
The heading and the content below it are slightly indented ([layout] h3_indent, content_indent).
### Languages
- [Rust](https://doc.rust-lang.org/std/)
Smaller headings
#### to ###### are small muted headings for little captions.
🧱 Cards and headings
Card
Every ## starts a new card with a frame; everything up to the next ## or # belongs to it.
Subheading
### structures the content inside a card.
small caption
#### is a muted caption,
even smaller
and the smallest
They have no indentation. Look: [style.h4] to [style.h6].
#### level 4 caption
##### level 5 caption
Lines and paragraphs
Every line in the file is a line on the page, an empty line starts a paragraph.
📝 Text and lines
Lines
First line
second line (just press Enter)
after a / line
you can use more slashes in a row for a bigger gap, here ///
A new paragraph after a blank line.
- Enter = new line, empty line = new paragraph with a gap
- a line with only
/inserts an empty line,//two,///three… /outside a card (right below#, or above##) makes a gap between cards, between---and#a gap between rows of columns- classic markdown behaviour (lines are joined) is restored by
[markdown] line_breaks = false
No empty line is needed before a list, table, quote, code block or heading, nor after a table; it is added automatically.
First line
second line
/
after an empty line
New paragraph.
Text
Font styles
Bold, italic and strikethrough.
✍️ Formatting
bold · italic · both
strikethrough · highlighted
The underscore variants work too: __bold__ and _italic_.
In the editor: Ctrl+B, Ctrl+I, Ctrl+Shift+X.
**bold** · *italic* · ***both*** · ~~strikethrough~~
Highlight
==text== puts a highlighter-style background behind a span.
✍️ Formatting
bold · italic · both
strikethrough · highlighted
Colour: mark_bg in the theme, look: [style.highlight]. In the editor: Ctrl+Shift+H.
Text with a ==highlighted part==.
Inline code
Text between backticks is code right in the line.
💻 Inline code
one-line code
highlighted print("hello")
backtick inside: `` a`b ``
#!language at the start turns on syntax highlighting.
A backtick inside code: `` a`b ``. In the editor: Ctrl+E.
`docker ps`
`#!python print("hi")`
Keys
++ctrl+b++ draws a keyboard shortcut.
✍️ Formatting
bold · italic · both
strikethrough · highlighted
keys Ctrl+B
tooltip ⓘ
custom icon ★
settings under in the top right
Keys are joined with +. Known names (ctrl, alt, shift, cmd, win, tab, esc, up, f1–f24, page-up, …) become key labels.
++ctrl+shift+t++ · ++f5++
Hints
[?](text) is an icon with a hint that shows on hover.
✍️ Formatting
bold · italic · both
strikethrough · highlighted
keys Ctrl+B
tooltip ⓘ
custom icon ★
settings under in the top right
On mobile it shows on tap. \n in the text breaks the line. Any character can replace ⓘ ([★](?…)).
Look: [style.tip]. [?](https://…) stays a plain link.
[?](hint text)
[★](?hint text)
Abbreviations
*[TOML]: … explains an abbreviation on hover.
📝 Text and lines
Lines
First line
second line (just press Enter)
after a / line
you can use more slashes in a row for a bigger gap, here ///
A new paragraph after a blank line.
Hidden notes
A text line starting with // is not shown:
Escaping
*asterisks*, # hash, [brackets], `backtick`
A backslash turns off formatting for a character.
The definition can be anywhere in the column and applies to the whole column.
Configuration in TOML.
*[TOML]: Tom's Obvious Minimal Language
Brackets
Brackets can be coloured in the config, e.g. for side remarks (in parentheses).
Each type (round, square, curly, angle) has its own section, e.g. [style.bracket_round] color = "muted". The default look is unchanged.
Text (in parentheses) and [square] and {curly}.
Escaping
A backslash before a character turns its formatting off.
📝 Text and lines
Lines
First line
second line (just press Enter)
after a / line
you can use more slashes in a row for a bigger gap, here ///
A new paragraph after a blank line.
Hidden notes
A text line starting with // is not shown:
Escaping
*asterisks*, # hash, [brackets], `backtick`
A backslash turns off formatting for a character.
Handy when you want to write *, #, [ or a backtick as they are.
\*asterisks\* \# hash \[brackets\]
Inline HTML
HTML in the text works: superscript and subscript, underline, custom styles.
🎯 Text appearance
↔️ Alignment
Signpost
signature on the right
A {: … } line right below a paragraph adds classes to it.
🔠 Size
small .small
normal text
bigger .big
huge .huge
🎨 Colours
Custom paragraph colour via style:
Just part of the text: orange and normal again.
🏷️ Attributes
Subheading on the right
Link in a new window: map
Anchor {#contact} after a heading: a link […](#contact) jumps to it.
🧩 HTML in text
x2 · H2O · underline · small text
HTML details
hidden content💅 Custom CSS
label ⚠ careful
BIG
A frame from <div>, with markdown inside thanks to markdown="1".
style="…"on<span>or<div>= custom CSS (colour, background, border)- markdown inside an HTML block is processed only if the block has the attribute
markdown="1" <details><summary>is a foldable block
<small>small</small> x<sup>2</sup> H<sub>2</sub>O <u>underline</u>
<span style="background:#a882ff33;border-radius:6px;padding:1px 8px">label</span>
Gear
{{gear}} puts the settings icon into the text.
✍️ Formatting
bold · italic · both
strikethrough · highlighted
keys Ctrl+B
tooltip ⓘ
custom icon ★
settings under in the top right
It is the same gear as in the bar, just as an icon (not a link). Handy in instructions and welcome texts.
under {{gear}} at the top right
Alignment and size
A {: … } line right below a paragraph aligns or enlarges it.
🎯 Text appearance
↔️ Alignment
Signpost
signature on the right
A {: … } line right below a paragraph adds classes to it.
🔠 Size
small .small
normal text
bigger .big
huge .huge
| class | result |
|---|---|
.center / .right |
centre / right alignment |
.big / .huge |
bigger / large font |
.small |
smaller font |
.muted |
muted colour |
Classes can be combined and work for headings and lists too. On a heading, {: … } can be at the end of the line or on the line below. Custom style: {: style="…" }, see Attributes.
Centred signpost
{: .center .big }
signature on the right
{: .right .muted }
Phone or computer only
{.mobile} and {.desktop} show a card or paragraph only on a phone, or only on a computer.
🎯 Text appearance
↔️ Alignment
Signpost
signature on the right
A {: … } line right below a paragraph adds classes to it.
🔠 Size
small .small
normal text
bigger .big
huge .huge
🎨 Colours
Custom paragraph colour via style:
Just part of the text: orange and normal again.
🏷️ Attributes
Subheading on the right
Link in a new window: map
Anchor {#contact} after a heading: a link […](#contact) jumps to it.
🧩 HTML in text
x2 · H2O · underline · small text
HTML details
hidden content💅 Custom CSS
label ⚠ careful
BIG
A frame from <div>, with markdown inside thanks to markdown="1".
🖥️ Computer only
A card with {.desktop} after the heading is only visible on a larger screen.
📱 Phone only
This card only shows on a phone.
📏 Breakpoint
Below a paragraph, {: .mobile } or {: .desktop } applies only to it. The breakpoint is 640 px.
The breakpoint is 640 px, the same as for stacking columns. After a ## heading it applies to the whole card, below a paragraph only to that paragraph.
## Tip for the phone {.mobile}
…
A paragraph for the computer only.
{: .desktop }
Attributes
{…} after an element adds a colour, class, anchor or another attribute.
🎯 Text appearance
↔️ Alignment
Signpost
signature on the right
A {: … } line right below a paragraph adds classes to it.
🔠 Size
small .small
normal text
bigger .big
huge .huge
🎨 Colours
Custom paragraph colour via style:
Just part of the text: orange and normal again.
🏷️ Attributes
Subheading on the right
Link in a new window: map
Anchor {#contact} after a heading: a link […](#contact) jumps to it.
You can add {#id}, {.class}, {key=value} and {: style="…" } after an element. On a heading, write the attributes at the end of the line or on a separate line right below it.
Paragraph.
{: style="color:#00bfa5" }
**text**{: style="color:#ff9100" }
[maps](https://www.openstreetmap.org){target=_blank}
Footnotes
[^1] in the text refers to a note listed at the bottom.
📝 Text and lines
Lines
First line
second line (just press Enter)
after a / line
you can use more slashes in a row for a bigger gap, here ///
A new paragraph after a blank line.
Hidden notes
A text line starting with // is not shown:
Escaping
*asterisks*, # hash, [brackets], `backtick`
A backslash turns off formatting for a character.
Footnotes appear at the end of the last card in the column. The identifier can be a word too ([^source]).
A claim with a footnote[^1].
[^1]: Footnote text.
Links and images
Links
[text](address) is a link, optionally with a title or with the address set aside.
✍️ Formatting
bold · italic · both
strikethrough · highlighted
keys Ctrl+B
tooltip ⓘ
custom icon ★
settings under in the top right
link code.nolog.cz/hindrich/h6082
nice link h6082
with a title h6082
another tab documentation
with a reference h6082, the address is separately below
e-mail e-mail (enable JavaScript)
External links open in a new tab ([page] links_new_tab). In the editor: Ctrl+K, or paste a URL over selected text.
[text](https://example.com)
[text](https://example.com "tooltip")
[text](/documentation)
[text][ref]
[ref]: https://example.com
Autolinks
A bare address in the text is a link by itself.
✍️ Formatting
bold · italic · both
strikethrough · highlighted
keys Ctrl+B
tooltip ⓘ
custom icon ★
settings under in the top right
link code.nolog.cz/hindrich/h6082
nice link h6082
with a title h6082
another tab documentation
with a reference h6082, the address is separately below
e-mail e-mail (enable JavaScript)
It is shown without https:// and the trailing slash. A link to http:// gets a warning mark, except for addresses on the local network (192.168.…, *.local, *.lan, localhost).
<https://example.com>
https://example.com/path
<[email protected]>
Protected e-mail
{{email name domain}} shows an e-mail address that bots will not find in the file.
✍️ Formatting
bold · italic · both
strikethrough · highlighted
keys Ctrl+B
tooltip ⓘ
custom icon ★
settings under in the top right
link code.nolog.cz/hindrich/h6082
nice link h6082
with a title h6082
another tab documentation
with a reference h6082, the address is separately below
e-mail e-mail (enable JavaScript)
Name and domain are written separately, so neither the md nor the HTML contains the address with an at sign. JavaScript in the browser builds the readable address and the mailto: link. Works anywhere in the text.
{{email name example.com}}
Images
 embeds an image, a banner or a small icon.
🖼️ Images
A card with only an image (at the top) is a banner without a frame.
An image alone in a paragraph stretches to the card width:
Icon in text is enlarged with
{width=32}.
Works in a list too:
Ben Nevis
Dolomites
🧩 More options
Image as a link: [ text](URL)
mountain map
Icons in a table:
| trip | km | |
|---|---|---|
| Ben Nevis | 12 | |
| Lake District | 25 |
Width in percent and centered:
Save your own images to content/media/ (svg png jpg webp gif avif) and insert them with . The description in […] is read by screen readers.
- save your own images to
content/media/and embed them via/media/<file>(svg png jpg webp gif avif ico) - an image alone in a paragraph stretches to the card width
- a card without a title that contains only an image is drawn without a frame, as a banner (the header of the settings page)
- set a smaller size with the
{width=…}attribute - images from the web (
https://…) work too, but the browser loads them from a foreign server
A script inside an SVG never runs, not even when the image is opened directly.

{width=20}
[{width=14} text](https://…)
Lists and tasks
Bullet lists
- at the start of a line is a list item.
📋 Lists
A bullet is -, nesting = 2 extra spaces (tab).
- bullet
- another
- nested
- and even deeper
- nested
Indent by 2 spaces to nest, in the editor Tab. Bullets are drawn as › ([style.list] marker). * and + work too.
In the editor: Ctrl+Shift+8.
- item
- nested
Numbered lists
1. at the start of a line is a numbered item.
📋 Lists
A bullet is -, nesting = 2 extra spaces (tab).
- bullet
- another
- nested
- and even deeper
- nested
Numbered list: 1., nesting is again 2 spaces.
A list can start at any number, the rest are counted on.
- you can start at five
- second
- nested
- third
Enter at the end of an item adds the next number. A list can start at any number. In the editor: Ctrl+Shift+7.
1. first
2. second
1. nested
Tasks
- [ ] is a task with a checkbox, - [x] a done task.
✅ Tasks
- [ ] is a task, - [x] a done task.
- check backups
- update the router
- download firmware
- order toner
- check the UPS
Click the box and the task is ticked right in the file. The + new task field adds another one.
In your tabs, tasks can be edited right on the page:
- a click on the checkbox ticks or unticks the task
- ✕ (on hover) deletes the task including its subtasks
- the + new task field adds a task to the end of the list
The change is written to the md file at once. Here in the documentation the tasks are read-only. In the editor: Ctrl+Shift+9.
- [x] done
- [ ] in progress
- [ ] subtask
Definition list
A term and : explanation below it.
📋 Lists
A bullet is -, nesting = 2 extra spaces (tab).
- bullet
- another
- nested
- and even deeper
- nested
Numbered list: 1., nesting is again 2 spaces.
A list can start at any number, the rest are counted on.
- you can start at five
- second
- nested
- third
A term and below it : explanation.
- TTL
- lifetime of a DNS record
- MX
- mail server of a domain
The term is on one line, the explanation on the next after :. There can be several explanations.
TTL
: how long a DNS record is valid
Due dates
@date at the end of a task shows a due-date label.
✅ Tasks
- [ ] is a task, - [x] a done task.
- check backups
- update the router
- download firmware
- order toner
- check the UPS
Click the box and the task is ticked right in the file. The + new task field adds another one.
Due date at the end of a task: a date @2026-12-01, or in how many days @+3, @-1 (yesterday), even with a time @+0 14:00.
- meeting
- renew certificate
- return book to the library
- renew domain
- file tax return
Overdue in red, within 3 days in orange, done in grey.
| syntax | due |
|---|---|
@2027-03-31 |
fixed date |
@2026-11-20 14:00 |
date and time |
@+3 · @-2 |
in 3 days · 2 days ago, counted from today (for templates and examples that should not age) |
@+0 14:00 |
today at 14:00 |
Within a week the label is relative ("in 2 days", "yesterday"), further out a date. Past due it is red, within 3 days orange, on a done task grey. The browser computes it from today's date; the file keeps what you wrote, so the task can still be ticked and edited.
- [ ] submit the annual report @2027-03-31
- [ ] meeting @2026-11-20 14:00
- [ ] renew the certificate @+2
Card content
Tables
Cells are separated by |, below the header is a |---| row.
📊 Table
Cells are separated by |, below the header goes a |---| row.
A colon aligns the column: :-- left, :-: center, --: right.
| service | port | status |
|---|---|---|
| web | 443 | ✓ |
| ssh | 22 | ✓ |
| backups | — |
Bold and strikethrough work in cells too.
The separator row sets the alignment: :-- left, --: right, :-: centre. Cells may contain inline formatting.
| service | port | status |
|:--|--:|:-:|
| home | 8088 | ✓ |
Code blocks
Code between ``` is a separate block, coloured by language.
💻 Inline code
one-line code
highlighted print("hello")
backtick inside: `` a`b ``
💻 Code block
1 2 3 4 | |
with syntax highlighting by language
hl_lines="3" highlights line 3, linenums="1" numbers the lines.- hover over the block: a copy button is at the top right
- language:
bash,python,yaml,toml,json,rust,nix,diff, … hl_lines="2 4-6"highlights lines,linenums="1"numbers them- colour scheme and line numbers globally:
[code]
```python hl_lines="2"
def hello(name):
return f"hello {name}"
```
Quotes
> at the start of a line is a quote, >> a nested one.
💬 Quotes and callouts
A plain quote starts with
>.
>>is a nested quote.
Enter in the editor continues the quote, on an empty line it ends it.
> A short quote or remark.
>> nested quote
Callouts
A quote with a type like [!tip] is a coloured box with a title.
💬 Quotes and callouts
A plain quote starts with
>.
>>is a nested quote.
A callout is a quote with a type [!…] and a title.
Types: note tip info warning danger.
Types: note · tip · info · warning · danger. Aliases from Obsidian and GitHub work too (important, caution, question, bug, success, …). Without a title the type is used as the title, a callout without content is just a coloured line.
> [!tip] Title
> content
Foldable callouts
- or + after the type makes the callout foldable.
💬 Quotes and callouts
A plain quote starts with
>.
>>is a nested quote.
A callout is a quote with a type [!…] and a title.
Types: note tip info warning danger.
Folded callout
- after the type folds it, a click opens it.
Unfolded callout
+ = open, but it can be folded.
Markdown, code and links work inside.
- = folded, + = unfolded but foldable.
> [!info]- Folded
> content
Admonition
!!! is a callout in MkDocs syntax.
💬 Quotes and callouts
A plain quote starts with
>.
>>is a nested quote.
A callout is a quote with a type [!…] and a title.
Types: note tip info warning danger.
Folded callout
- after the type folds it, a click opens it.
Unfolded callout
+ = open, but it can be folded.
Markdown, code and links work inside.
🎨 More options
Without a title, the type is used as the title.
Names from Obsidian and GitHub work too, they take the colour of the base type:
MkDocs syntax works as well:
Admonition
content indented by 4 spaces
Folded block
???+ opens it right away.
The content is indented by 4 spaces. The result is the same as a callout.
!!! warning "Title"
content indented by 4 spaces
Details
??? is a foldable block in MkDocs syntax.
💬 Quotes and callouts
A plain quote starts with
>.
>>is a nested quote.
A callout is a quote with a type [!…] and a title.
Types: note tip info warning danger.
Folded callout
- after the type folds it, a click opens it.
Unfolded callout
+ = open, but it can be folded.
Markdown, code and links work inside.
🎨 More options
Without a title, the type is used as the title.
Names from Obsidian and GitHub work too, they take the colour of the base type:
MkDocs syntax works as well:
Admonition
content indented by 4 spaces
Folded block
???+ opens it right away.
??? = folded, ???+ = unfolded. The content is indented by 4 spaces.
??? note "Folded"
content
Note
{{note}} … {{/note}} is a field you type into right on the page.
📝 Note
Between {{note}} and {{/note}} there is a field you type into right on the page.
It saves itself into the md file. Markdown is not rendered in it, it is plain text.
- the text between the markers is plain text, markdown is not rendered in it
- in your tabs it saves itself ~0.8 s after the last change, the field grows with the text
- if the note was changed elsewhere in the meantime, saving is refused and nothing is overwritten
- writing requires the editor password, here in the documentation it is read-only
{{note}}
milk, bread
call the plumber
{{/note}}
Divider
--- between empty lines draws a horizontal line.
📝 Text and lines
Lines
First line
second line (just press Enter)
after a / line
you can use more slashes in a row for a bigger gap, here ///
A new paragraph after a blank line.
Hidden notes
A text line starting with // is not shown:
Escaping
*asterisks*, # hash, [brackets], `backtick`
A backslash turns off formatting for a character.
An empty line must precede ---, otherwise the previous line turns into a heading.
above the line
---
below the line
Live widgets
Service status
{.check} after a link shows with a coloured dot whether the service responds.
| dot | status |
|---|---|
| 🟢 | OK |
| 🟠 | 4xx: running, but needs a login etc. |
| 🔴 | 5xx, timeout or unreachable |
{.check}checks the link address over HTTP(S){check="…"}is a custom target:https://…ortcp://host:port- hover shows the status code, latency or error
- refreshed every
[checks] interval_s - made-up status for examples: sample data
Checks run from the server in the container. Services on the host: host.docker.internal:<port>. The server only checks targets written in md files.
[GitHub](https://github.com){.check}
[NAS](http://nas.lan){check="tcp://192.168.1.50:22"}
Server
{{sys}} shows the server's CPU, memory and disk usage.
- parts, without parameters all are shown:
| part | shows |
|---|---|
cpu |
CPU usage |
cpuinfo |
cores × CPU model |
mem · swap |
memory and swap use |
load |
load average 1 · 5 · 15 min, the bar = last minute ÷ cores |
procs |
processes in total and running |
io |
disk read ↓ and write ↑ per second |
temp |
temperatures ([system] temps) |
disk |
disk use ([system] disks) |
uptime |
time since boot |
- swap and temperatures show only where the server has them; network traffic is left out, a container sees only its own
- values refresh every
[system] interval_sseconds - the bar is orange from 70 %, red from 90 %
Set [system] enabled = true in config.toml. Off by default, because /api/sys is visible to anyone who can see the page. Made-up values for examples: sample data.
{{sys}}
{{sys cpu mem disk}}
RSS
{{rss URL}} lists the latest articles from a feed.
🟢 Live widgets
Service status
Server
{{sys}}: the server's CPU, memory and disk.
RSS
{{rss URL 3}}: the latest 3 articles from a feed.
- the whole line = one feed, the number = item count (default
[rss] default_limit) - RSS 2.0, RSS 1.0 and Atom
- 💬 = link to the comments, if the feed has them
- the server caches the feed for
[rss] refresh_minminutes and shows the last known state if the source is down - made-up titles for examples: sample data
{{rss https://news.ycombinator.com/rss 5}}
Change history
{{history}} lists the latest file edits.
🟢 Live widgets
Service status
Server
{{sys}}: the server's CPU, memory and disk.
RSS
{{rss URL 3}}: the latest 3 articles from a feed.
Changes
{{history 3}}: the latest file edits, a click shows the diff.
- latest changes: time, file, added and removed lines
- a click opens the diff with an option to restore the version (with the editor password)
- versions are created automatically by edits from the editor and from elsewhere, edits within 5 minutes are merged
The history shows the names of your files and when you edited them. Made-up changes for examples: sample data.
{{history}}
{{history 20}}
{{history demo.md 5}}
Countdown
{{countdown date}} shows how long until a date, or how long since it.
🟢 Live widgets
Service status
Server
{{sys}}: the server's CPU, memory and disk.
RSS
{{rss URL 3}}: the latest 3 articles from a feed.
Changes
{{history 3}}: the latest file edits, a click shows the diff.
Countdown
{{countdown 2026-12-24}} anywhere in text, or in how many days: holiday .
After the date it counts back, days shows just the number: h6082 has been running .
| syntax | shows |
|---|---|
{{countdown 2027-01-01}} |
"in 39 days", "tomorrow", "today", "3 days ago" |
{{countdown 2027-01-20 9:00}} |
with a time also "in 5 h" |
{{countdown 2026-11-12 days}} |
just the number of days ("3 days") |
{{countdown +12}} |
12 days from today |
The browser computes it from its clock and refreshes it every minute, hover shows the full date. Works anywhere in the text.
New Year {{countdown 2027-01-01}}.
Holiday {{countdown +12}}.
Shortcodes
Shortcodes
A line containing only a shortcode is replaced by generated content, e.g. the Server, Change history and RSS cards above.
{{files}}: list of files with view and edit buttons.user= only yours,system= documentation, configuration and markdown.{{newfile}}: form for a new.mdfile{{theme}}: theme drop-down with a colour preview, a choice saves[theme] default{{lang}}: language drop-down, saves[page] lang{{email name domain}}: protected e-mail{{countdown date}}: countdown to or since a date{{gear}}: settings gear in the text
{{email}}, {{countdown}} and {{gear}} also work mid-line. Several line shortcodes on one line ({{lang}} {{theme}}) are shown side by side. Shortcodes are not executed inside a code block.
{{files}}
{{newfile}}
{{rss URL [count]}}
{{sys [parts…]}}
{{history [file] [count]}}
{{note}} … {{/note}}
{{theme}}
{{lang}}
{{email name domain}}
{{countdown date [time] [days]}}
{{gear}}