Markup - Markdown

markdown is a Lightweighted markup language.

Github by default uses Markdown syntax

• http://commonmark.org/ is the reference
• http://daringfireball.net/projects/markdown/syntax is the original
• GitHub Flavored Markdown Spec based on CommonMark
• rfc7763 - The text/markdown Media Type

Same as for HTML: HTML - Comment

![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional title" =100x20)
![Alt text](/path/to/img.jpg =100)

• Eclipse: Wiki Text with outline ! Just install Eclipse. F1 > Markdown Markup Cheat Sheet. Table implementation are just plain HTML
• Idea Intellij with plugin
• VsCode

• https://strapdownjs.com/

<xmp theme="united" style="display:none;">
# Markdown text goes in here

## Chapter 1

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore
et dolore magna aliqua. 

## Chapter 2

Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
culpa qui officia deserunt mollit anim id est laborum.
</xmp>

<script src="https://strapdownjs.com/v/0.2/strapdown.js"></script>

This framework does not have any idea of a link to a md file.

• Hugo
• https://www.11ty.io/docs/languages/markdown/ - Eleventy - Jenkyll replacement -

• Pandoc - Doc - http://pandoc.org/MANUAL.html

geared towards building project documentation.

mkdocs new [dir-name] #- Create a new project.
mkdocs serve #- Start the live-reloading docs server.

• Create a new directory, named site

mkdocs build #- Build the documentation site.
mkdocs build --clean #- Delete the content of the site dir
mkdocs build --help

• Help message

mkdocs help #- Print this help message.

• Getting Started
• Homepage: By convention index.md
• Doc
• Configuration
• Syntx followed is Python Markdown

• Java: Pegdown, https://github.com/rjeschke/txtmark
• React: https://github.com/rexxars/react-markdown
• cmark - is the C reference implementation of CommonMark. It's a parsing and rendering library
• sundown - github - Standards compliant markdown processing library in C

• https://github.com/remarkjs/remark/tree/master/packages/remark-parse - Parser that generate the below tree (mdast)
• https://github.com/syntax-tree/mdast#list-of-utilities - Tree
• https://github.com/chjj/marked/ - Js parser

https://github.github.com/gfm/ - GitHub Flavored Markdown Spec

CommonMark refernce syntax build with their own tool sundown. Seeblog

• Syntax
• Plugin Maven
• https://packaging.python.org/specifications/core-metadata/#description-content-type-optional