Markdown

This document describes the Markdown variant that KF implements. The base spec is the one from commonmark.org, but we do not try to be 100% compatible so that some special features can be added.

https://www.markdownguide.org/

Title

#! Title

Headers

Headers start with one or more (up to 6) '#', followed by a space and text, up to the end of the line. Numbered headers are not supported.

An optional reference in the form {#ref} can be added before the end of line. This reference will be the ID attribute of the header an can later be used to access document parts.

Headers

# Chapter 1 {#chapter1} {!type}

{#token} substitutes the normalized header. {!type} states the type of this section, and is used in document comparisons.

Lists

Lists

- item 1
- item 2

Numbered lists

+ item 1
+ item 2

Task lists

- [/] item 1
- [ ] item 2
- [x] item 2

Numbered task lists

+ [/] item 1
+ [ ] item 2
+ [x] item 2

Definition lists

Paragraph

A paragraph ends when another block command, an empty line or the end of the text is found.

Paragraph styles

.p style="css"
text
more text
.p blockquote
text
more text
 `
 monospace text
 `

Links

[title](url)

Images

![title](url)
![title](url style="css")

Tables

Table alignment

Table style

Horizontal ruler

---

Text formatting

  • Subscript, superscript <sub>
  • bold, italic
  • columns
  • highlight <mark>
  • centered text <center> transform into div style
  • font styling: use HTML
  • Symbols: use Unicode or HTML
  • Underline: <u>

Unimplemented MD features

  • Automatic URL Linking
  • Comments: use HTML comments

Math

Mathjax is integrated. Inline equations use \\(...\\), while centered equations use \\[...\\]



/products/kf/markdown