Writing markdown

  How-To Guides

What is markdown?

Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents.

Using Markdown is different than using a WYSIWYG editor. In an application like Microsoft Word, you click buttons to format words and phrases, and the changes are visible immediately. Markdown isn’t like that. When you create a Markdown-formatted file, you add Markdown syntax to the text to indicate which words and phrases should look different.

For instance, to denote a heading, you add a number sign before it (e.g., # Heading One). Or to make a phrase bold, you add two asterisks before and after it (e.g., **this text is bold**). It may take a while to get used to seeing Markdown syntax in your text, especially if you’re accustomed to WYSIWYG applications.

Example

The text on the left is what is written. Once rendered it appears as shown on the right.

What styling options are available in markdown?

See here for help on markdown syntax usable in the notebook.