Resources

Markdown Tutorials

Markdown Reference

Markdown Tools

  • Text editors: you don’t need a fancy tool! Markdown can be written by any text editor. For basic writing, Windows Notepad++, Mac TextEdit, or Linux Gedit are sufficient. For larger projects or notes, a more complete code editor might be helpful such as Visual Studio Code.
  • Web app editors:
    • Dillinger (sync with cloud services, collaborate, comments, LaTeX Math, UML diagrams, ABC notation for music)
    • StackEdit (sync with cloud services, collaborate, comments, LaTeX Math, UML diagrams, ABC notation for music)
    • HackMD Markdown realtime collaboration platform (self-hosted open source version CodiMD)
  • Publishing workflows: Manubot, Quarto
  • Note taking: Obsidian, Notable, Simplenote, Standardnotes, Joplin
  • Visual editors: stand alone desktop apps with familiar GUI interface and builtin output options
  • Libraries: the Demo editor uses markdown-it library to render Markdown using JS.

Accessibility

LaTeX and Pandoc:

Homework and LMS:


Install Pandoc

Pandoc is a command line utility to translate between many formats and generate new output versions, such as PDFs (via LaTeX).

To create PDFs from Markdown, you will need Pandoc plus a LaTeX distribution. Check the Installing Pandoc guide for full details. Here is the suggested method:

Windows and Mac
  1. Download and install a LaTeX distribution. These are big packages so this step can take a long time!
  2. Download the latest installer release for your platform from Pandoc Releases.
    • For Windows look for the extension .msi, e.g. pandoc-2.10.1-windows-x86_64.msi
    • For Mac look for the extension .pkg, e.g. pandoc-2.10.1-macOS.pkg
  3. Run the Pandoc installer.
Linux

Pandoc and LaTeX are available in most distro’s repositories. These might not be most up-to-date versions, but are the best way to install.

On Ubuntu: sudo apt install pandoc texlive texlive-fonts-extra texlive-xetex