Markdown

Markdown

Writing Documentation with Markdown Syntax
## Markdown Headers ### Markdown Lists * List Item * List Item * List Item 1. Numbered List 1. Numbered List 1. Numbered List
## Markdown Headers ​ ### Markdown Lists * List Item * List Item * List Item ​ 1. Numbered List 1. Numbered List 1. Numbered List​

Why Use Markdown?

  1. ​Edit a document anywhere with any editor (notepad for instance).
  2. Full control over formatting (no need to worry about why pasting messed up a list or a table).
  3. Easily add code snippets with syntax highlighting as opposed to screenshots
  4. Write step-by-step instructions that can be imported in to destinations like GitHub, Bitbucket, and Confluence.
  5. Export into formats such as Word, PDF, and HTML.
  6. Write documentation that isn't in a proprietary format.

Why not use Markdown?

  1. ​Learning curve on some of the syntax and formatting.
  2. Tables can be a lot harder to write than using a GUI.
  3. Not all Markdown formatters produce the same output (custom styles and themes).
  4. A really good desktop experience for previewing Markdown doesn't exist.
| Table Header | Centered | Right-Aligned | | --- | :---: | ---: | | Normal Data | Centered Data | 1.00 | | Normal Data | Centered Data | 100.00 | | Normal Data | Centered Data | 1000000.00 |

Markdown as HTML

Markdown in Confluence

Markdown Converted to Word

Clients for Markdown

Desktop 1. Notepad (will still need a compiler) 1. Typora (in beta) 1. MarkdownPad 2 1. VisualStudio Code (with appropriate plugins for compiling) Web 1. [StackEdit](https://stackedit.io/) 1. [Dillinger](https://dillinger.io/) 1. [GitHub](https://github.com) (requires account)