Markdown - FTSRG/cheat-sheets GitHub Wiki

Markdown is a text formatting syntax used in a wide scale of applications, such as GitHub and Stack Overflow.

Markdown logo

Markdown comes in many flavors, including Pandoc Markdown, Multimarkdown, PHP Markdown Extra. GitHub and Stack Overflow also have their own flavors.

Presentations

Using Madoko, you can create presentations in Markdown and export them to HTML or PDF. Check out the demo presentation.

Markdown for scientific documents

See the Markdown for Scientific Documents page.

Markdown for e-mail (and more)

Use Markdown Here to create e-mails and rich text easily in Markdown.

Converting Markdown documents to Word

wget https://raw.githubusercontent.com/FTSRG/trainbenchmark-core/master/README.md
wget https://github.com/FTSRG/thesis-template-word/raw/master/thesis.docx
pandoc README.md --from=markdown_github --reference-docx=thesis.docx --output=README.docx

GitHub specific tricks

Add references:

  • [this section](/FTSRG/cheat-sheets/wiki/Markdown#github-specific-tricks) -> this section
  • [resource in wiki](/FTSRG/cheat-sheets/wiki/figures/Word/heading-looks.png) -> resource in wiki
  • [resource in repository](../../blob/master/PowerPoint/powerpoint2pdf.vb) -> resource in repository
    • Use ../ to navigate up with relative path
    • Make sure to remove / from the end of the link!
    • These links will work even if the repository name is changed or if someone clones or forks the repo.