Markdown is an easy-to-use markup language, used to format docs for web, using plain text.

It is used by DataHub, Github, Stackoverflow and many other sites.

Basics

usual text usual text
*italic text* italic text
**bold text** bold text,
~~crossed though~~ crossed though
double space - linebreak

--- horizontal line like this:


Blockquotes

Santa Claus said:

> Happy Christmas, hohoho

Santa Claus said:

Happy Christmas, hohoho

Headers

# this is a Header1
## Header2
...
###### Header6

https://example.com https://example.com - automatic
[Example](https://example.com) Example - defined text
![alt text](https://goo.gl/YPFoy5 "image title") alt text

Lists

* task 1
* task 2
  * task 2a
  * task 2b
  • task 1
  • task 2
    • task 2a
    • task 2b

List with checkboxes:

* [x] unchecked 
* [ ] checked
  • [x] task 1
  • [ ] task 2

Code

This is an inline code: `inline code`

This is an inline code: inline code

Multi-line code starts with triple backtick (also you can add the programming language name - ```[python|bash|php|etc]
print('hello world)

print('hello world')

and ends with triple backtick apostrophe as well.


As you can see, formatting text with Markdown is as easy as using notepad. Also, the markdown syntax could be extended easily, and here is the extra features, you can use to format pages for datahub.

DataHub specific features

FrontMatter

In the world of computer programming, frontmatter is metadata at the top of a file. Just put your metadata between two lines like this:

---
title: 5 minutes Markdown guide
date: 2017-12-21
---

And our site will use this metadata while forming the page. The result you can see on top of this page (‘author’ is used in the blog posts).

Table of contents

If you will add [[toc]] in your document - this will be automatically transformed into Table Of Content section, with links to all your Headers.