Everything you need to write a post for the knowledge base
A post is a single .md file in the posts folder.
You write plain text, run one script, and it appears on the site. No HTML, no CMS,
no server.
posts/_TEMPLATE.md and rename it, for example
posts/se16n-tips.md. There is a download button at the bottom of this
page.build.bat in the site folder. It regenerates
titles.md, downloads any images you linked, and makes the post
searchable.The file name becomes the address of the post, so keep it short, lowercase and without
spaces. posts/st22-dumps.md becomes
post.html?p=st22-dumps. Use hyphens instead of spaces. Files starting with
an underscore (like _TEMPLATE.md) are ignored by the build, which is handy
for drafts.
Every post starts with a few lines of information about the post, followed by one blank line, and then the content. The blank line matters — it tells the build where the header ends.
Title: Analyzing Short Dumps (ST22) Category: Troubleshooting Date: 2026-10-13 Tags: ST22, dump, runtime error Author: K. Kyprianidis Your first paragraph starts here, after the blank line.
| Line | Required | What it does |
|---|---|---|
Title: | Recommended | The heading of the post, the browser tab name, and the title on the cards. If you leave it out, the file name is used instead. |
Category: | No | Groups the post and creates a filter button on the All Posts page. Reuse the
existing ones where you can: Debugging, Daily Ops, Performance, Troubleshooting,
SAP Logon. Defaults to General. |
Date: | No | Sorts the post. Use 2026-10-13 or 13.10.2026. If you
leave it out, the file's last modified date is used. |
Tags: | No | Comma separated extra search keywords — transaction codes, function module names, anything a colleague might type into the search box. |
Author: | No | Shown in small text under the post title. |
The number of # characters sets the level. More hashes means a smaller,
deeper heading. Always put a space after the hashes.
Do not write a # heading for the post title.
The Title: line already produces it. If you do use a single #
in the body it is automatically turned into a ## so the page keeps one
main heading. Start your sections at ## and use ### for
subsections.
Use `backticks` for anything you would type into SAP —
transaction codes, field names, table names, report names. It makes posts far easier to
skim.
Bullet lists use -, numbered lists use 1.. Indent by three
spaces to nest one inside the other.
Numbering continues correctly even when you put an image or a
paragraph between two steps — write 2. and it stays 2.
To link to another post, use
post.html?p= followed by its file name without the .md.
External links open in a new tab automatically.
This is the easy part. Paste the link exactly as you copied it — from a GitHub comment, a ticket, anywhere:
The text in the square brackets is the description shown if the image cannot be displayed. The link goes in the round brackets.
When you run build.bat, the image is downloaded into the site folder
and your link is rewritten automatically to point at the local copy:
So the post keeps working with no internet connection, and the screenshot can never
disappear on us. Each post gets its own folder under data/images/. You do
not have to do anything — just paste the link and build.
Tip
If the download fails — no connection, VPN down — the build warns you and leaves the link alone, so nothing breaks. Just run it again later.
If you already have the image file on your PC, put it in assets/img/ and
link it directly: 
Put three backticks on a line of their own, your code, then three backticks again. ABAP is the default, so you do not need to say so:
For anything that is not ABAP, write the language after the first
three backticks: sql, javascript, json,
bash. Use text to switch the colouring off — good for SAP
messages, job logs and dump output.
These are the coloured boxes. Write > [!NOTE] on one line, then your
text on the next line, also starting with >. Five types are available —
pick the one that matches how badly the reader needs to stop and pay attention.
A > on its own, without [!...], gives
you a plain quote box.
Separate the columns with |. The second row of dashes is what makes it a
table. The columns do not need to line up in the source.
Add a colon to the dashes to change alignment:
---: right, :---: centre.
`backticks`?# heading for the title?posts folder, rename it, and start writing.