HOWTO WIKI¶

Das WIKI verwendet markdown-Textdokumente und mkdocs/mkdocs-material zur Darstellung einer HMTL-Version des Wikis. Die Daten liegen unter ~/Dokumente/wiki/docs/.

Render WIKI to HTML¶

    # MKDOCS muss installiert sein
    dnf install mkdocs
    dnf install mkdocs-material             # ???
    dnf install mkdocs-material-extensions  # ???

    pip install mkdocs-material-extensions  # ???

    # HTML Version des Wikis aus dem Wurzelverzeichnis erzeugen
    # Konfigruation mittels ./mkdocs.yml

    cd ~/Dokumente/wiki
    mkdocs build
    mkdocs serve

Markdown Cheat Sheet¶

Thanks for visiting The Markdown Guide!

This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can’t cover every edge case, so if you need more information about any of these elements, refer to the reference guides for basic syntax and extended syntax.

Basic Syntax¶

These are the elements outlined in John Gruber’s original design document. All Markdown applications support these elements.

Heading¶

# H1
## H2
### H3

Bold¶

**bold text**

Italic¶

*italicized text*

Blockquote¶

> blockquote

blockquote

Ordered List¶

1. First item
2. Second item
3. Third item

1. First item
2. Second item
3. Third item

Unordered List¶

- First item
- Second item
- Third item

• First item
• Second item
• Third item

Code¶

`code`

code

Horizontal Rule¶

---

Link¶

[title](https://www.example.com)

title

Image¶

![alt text](image.jpg)

Extended Syntax¶

These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.

Table¶

| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |

Fenced Code Block¶

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

Footnote¶

Here's a sentence with a footnote. [^1]

  [^1]: This is the footnote.

Here's a sentence with a footnote. ¹

Heading ID¶

##### My Great Heading {#custom-id}

My Great Heading¶

Definition List¶

term
: definition

term

definition

Strikethrough¶

~~The world is flat.~~

The world is flat.

Task List¶

- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media

• Write the press release
• Update the website
• Contact the media