Markup - Markdown

About

markdown is a Lightweighted markup language.

Github by default uses Markdown syntax

Syntax

Reference

Comment

Same as for HTML: HTML - Comment

Image

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

Tools

Editor

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

Generator

Html Page

<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>

Blog

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

Book

Wiki (doc)

mkdocs

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.

Library

Parser

Note

Github

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

CommonMark refernce syntax build with their own tool sundown. Seeblog

Documentation / Reference


Powered by ComboStrap