Markdown

From XennisWiki
Jump to: navigation, search

Markdown is a plain text formatting syntax designed so that it can optionally be converted to HTML using a tool by the same name. Markdown is popularly used as format for readme files, or for writing messages in online discussion forums, or in text editors for the quick creation of rich text documents. (Wikipedia)

Basics

Further information: Markdown Cheatsheet

Emphasis

*italics emphasis* or _italics emphasis_.
**strong emphasis** or __strong emphasis__
~~strikethrough~~

Headlines

# Headline 1
## Headline 2
### Headline 3

Links

Link to a website or file

[Django](http://www.djangoproject.com/)
[see requirements.txt](../requirements.txt)

List

Unordered list (instead of * also + (plus) and - (minus) could be used)

* First item
* Second item
    * First sub item
    * Second sub item

Numbered list

1. First item
2. Second item

    Text accordingly the second item

3. Third item

Image

![My image](/path/to/image.png)

Code

Inline code

Use the command `python manage.py runserver` to run the server.

Code block

```python
from django.contrib.auth.models import User
u = User.objects.get(id=1)
```

See also

  • Hugo a static site generate with Markdown

External links