Markdown reference

This section shows examples of how to write content with markdown. DocGen uses a markdown standard called CommonMark (see the CommonMark Spec for more detailed information).

Element What you type What it looks like in DocGen

Page Heading

  
  # Page Heading

Page Heading

Section Heading

 
  ## Section Heading

Section Heading

Minor Heading

 
  ### Minor Heading

Minor Heading

Fake Heading
(not in PDF contents list)

 
  <p class="dg-fakeHeading">Fake</p>

Fake

Emphasis (italic)

 
  This text has *emphasis*

This text has emphasis

Strong (bold)

 
  This text is **bold**

This text is bold

Block quotes

   
  > This is a block quote.

This is a block quote

Code block
(indent with tab)

 
      int some_code=0

int some_code=0;

Unordered List

 
  * unordered list
  * (items)

unordered list
(items)

Ordered List

 
  1. ordered list
  2. (items)

ordered list
(items)

External Links

 
  [link](http://www.google.com)

link

Links to a local file

 
  [attachment](user_guide.pdf)

attachment

Diagrams
(embedding images)

 
  ![](files/images/logo.svg)

Simple table

  
  | Cell 1 | Cell 2 | Cell 3 |
  | Cell 4 | Cell 5 | Cell 6 |

Cell 1	Cell 2	Cell 3
Cell 4	Cell 5	Cell 6