To create main description, you simply use #
to mark down initial name of the chapter.
As you can see in the sidebar, lines beginning with ##
are considered as chapters and automatically populated to create list of contents.
Depending on your settings, ###
are still acting as a sub-chapter, but it is not shown in sidebar. Have a look at index.html
file. This is where you configure, how many levels will be displayed by sidebar.
Does it even exists? :)
MarkDown itself is very simple.
*italic*
will result italic.
**bold**
will result bold.
Use >
to create quotes like this:
Some famous quote.
Written by:
Cicero
Create a divider line by putting ---
or ***
or ___
to your document:
Lists can be achieved simply by putting -
or *
or +
at the start of the line, have a look:
- Apples
- Pears
- Oranges
- Bananas
- Grapes
Alternatively, you can create numbered lists simply by putting numbers on start of the line.
- First
- Second
- Third
- Fourth
- Fifth
Simple tables are also possible in MarkDown, see below:
Tables | Are | Cool |
---|---|---|
Last column is | right-aligned | $1600 |
Middle column is | centered | $12 |
I like beer | and nuts | $1 |
And the source code looks like this:
| Tables | Are | Cool |
| ---------------- |:-------------:| -----:|
| Last column is | right-aligned | $1600 |
| Middle column is | centered | $12 |
| I like beer | and nuts | $1 |
There is much more to learn! For example, there are also some flavours of MarkDown (ie. Github flavoured MarkDown), allowing you to do more. Figure out by our own, how the source code of following examples looks like:
!> Time is money!
?> TODO list
- first
- one
- two
- three
- second
Please continue with sidebar table of contents to explore more options.
BTW this is file document.md
, when you look inside repository.