Markdown

Markdown is a plain text format for writing documents, offering an good balance of readability, simplicity, and functionality for creating structured content on its own. In KF it is used in the 'text' field of each item, while the item is being edited. Later is rendered as HTML.

This document describes the Markdown variant that KF implements. It has some differences with respect to Commonmark.

The following items differ:

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

Task lists

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

Definition lists

Paragraph

A paragraph is a sequence of text lines that are not recognized as any other instruction. It ends when an empty line or another instruction is found.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus luctus
purus a dolor consectetur, in aliquet est tristique. In nec ante velit. 
Integer condimentum sit amet diam at tincidunt. 
 

Paragraph styles

 `
 monospace text
 `

A link to a file has the form:

[title](url)

A link to an image has one of the forms:

![title](url)
![title](url css)

An optional CSS string can be added, as for example width:50%.

When droping (or pasting from the clipboard) a file into the text area, the file is uploaded and a link is created automatically, at the point where the cursor is located at that moment.

When droping (or pasting from the clipboard) an image into the text area, the image is uploaded and a link is created automatically, at the point where the cursor is located at that moment. Images are recognized if they have one the extensions: ".jpg", ".jpeg", ".png", ".gif", ".svg" or ".webp".

Tables

| A      | B     |
| ------ | ----- |
| a1     | b1    |
| a2     | b2    |
|| A     | B     |
| ------ | ----- |
| a1     | b1    |
| a2     | b2    |
| a     | d    |
| b     | e    |
| c     | f    |
|| A     | B     |
| a1     | b1    |
| a2     | b2    |
.csv [format]
a,b,c
d,e,f
 

Table style

Horizontal ruler

---

Text formatting

Unimplemented MD features

Math

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

Commands

The following commands are recognized (copy them as is):

CommandDescription
.var db.FT(R.id)Insert here the fault tree of the current item