markdown is a Lightweighted markup language.
Github by default uses its own Markdown syntax called gfm
# Your title
#(id=#custom-id tight=true bullet_char=-) Your title
#{id=#custom-id tight=true bullet_char=-} Your title
![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional title" =100x20)
![Alt text](/path/to/img.jpg =100)
This framework does not have any idea of a link to a md file.
geared towards building project documentation.
mkdocs new [dir-name] #- Create a new project.
mkdocs serve #- Start the live-reloading docs server.
mkdocs build #- Build the documentation site.
mkdocs build --clean #- Delete the content of the site dir
mkdocs build --help
mkdocs help #- Print this help message.
https://github.github.com/gfm/ - GitHub Flavored Markdown Spec
Gfm was build on top sundown but is now build on top of CommonMarc. 1)
This paragraph tries to summarize the type of parsing strategy used by several different markdown parser
Example of AST: CommonMark (DTD)
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document SYSTEM "CommonMark.dtd">
<document xmlns="http://commonmark.org/xml/1.0">
<list type="ordered" start="1" tight="true" delimiter="period">
<item>
<paragraph>
<text>A paragraph</text>
<softbreak />
<text>with two lines.</text>
</paragraph>
</item>
</list>
</document>