Here is an example with a very simple file. Tip: You can also right-click on the editor Tab and select Open Preview (⇧⌘V (Windows, Linux Ctrl+Shift+V)) or use the Command Palette (⇧⌘P (Windows, Linux Ctrl+Shift+P)) to run the Markdown: Open Preview to the Side command (⌘K V (Windows, Linux Ctrl+K V)). Dynamic previews and preview locking. This is the compantion repository for the book Markdown By Example. The file buildexamples.sh builds all Markdown examples into HTML files or their respective output formats. extra Additional examples misc Code snippets from all chapters, Footnotes sample Markdown for sample eBook.

1. Markdown Cheatsheet
2. Julia Embed Latex In Markdown Example
3. Markdown Example

Markdown is probably the most commonly-used plain text markup used online, and is easy to get started with. The specific flavor of Markdown that Rippledoc uses is Pandoc-Markdown. Here’s a quick example of some pandoc-markdown -formatted text: first as the source you’d put into your file, then rendered as html.

And here’s that text rendered as html:

Paragraphs are separated by a blank line.

2nd paragraph. Italic, bold, and monospace. Itemized lists look like:

Markdown Cheatsheet

• this one
• that one
• the other one

Note that — not considering the asterisk — the actual text content starts at 4-columns in.

Block quotes are written like so.

They can span multiple paragraphs, if you like.

Use 3 dashes for an em-dash. Use 2 dashes for ranges (ex., “it’s all in chapters 12–14”). Three dots … will be converted to an ellipsis. Unicode is supported. ☺

An h2 header

Julia Embed Latex In Markdown Example

Here’s a numbered list:

1. first item
2. second item
3. third item

Note again how the actual text starts at 4 columns in (4 characters from the left side). Here’s a code sample:

As you probably guessed, indented 4 spaces. By the way, instead of indenting the block, you can use delimited blocks, if you like:

(which makes copying & pasting easier). You can optionally mark the delimited block for Pandoc to syntax highlight it:

An h3 header

Now a nested list:

1. First, get these ingredients:

   • carrots
   • celery
   • lentils

2. Boil some water.

3. Handspring visor driver for mac. Dump everything in the pot and follow this algorithm:

   Do not bump wooden spoon or it will fall.

Notice again how text always lines up on 4-space indents (including that last line which continues item 3 above).

Here’s a link to a website, to a local doc, and to a section heading in the current doc. Here’s a footnote ¹.

Tables can look like this:

Markdown Example

(The above is the caption for the table.) Pandoc also supports multi-line tables:

Akvis lightshop v.4.0 serial. A horizontal rule follows.

Here’s a definition list:

apples

Good for making applesauce.

oranges

Citrus!

tomatoes

There’s no “e” in tomatoe.

Again, text is indented 4 spaces. (Put a blank line between each term and its definition to spread things out more.)

Here’s a “line block” (note how whitespace is honored):

and images can be specified like so:

Inline math equation: (omega = dphi / dt). Display math should get its own line like so:

[I = int rho R^{2} dV]

And note that you can backslash-escape any punctuation characters which you wish to be displayed literally, ex.: `foo`, *bar*, etc.

Pandoc also allows you to do a few more things besides. You can read more about that in the Pandoc Manual.

1. Some footnote text.↩