Say hello to Markdown!

Be in control of how your startup reports are formatted.

 

Markdown is a simple method to format and style text on the web. You can get access to the standard methods of formatting words that you're familiar with by including a few non-alphabetic characters within your text. A few examples that you can do with Markdown include formatting words as bold or italic, creating list styles such as bullets or even adding images.


Syntax guide

Use the following guide to help format your reports. Formatting will help break up your content so that it is easier to read and understand.

 

Heading styles

Different heading styles are important to establish hierarchy when you have some content that you want to separate. It will allow your audience to easily understand which pieces of content belongs to which section/headings. It's especially useful to break up different points of interest that you may be discussing.

# This is an h1 tag
## This is an h2 tag
###### This is an h6 tag

The number of # will determine what heading style you will use for that line. H1 being the most important heading and H6 being the least important. In most cases, using H1 to H3 should be enough but you have the option to go all the way to H6 if needed.

Example:

h1 - Main Heading

The main heading is used very sparingly, usually as a page title to set the scene, explaining what the document/page is about.

h2 - Section heading

The section heading, or h2 is usually used to break up different topics or ideas within the document/page. It allows you to organise and separate different ideas you wish to communicate to your audience.

h3 - Minor heading

Use h3 to further break down different points within a section. If you only have one section in your document/page, you may choose to only use h3 and not use h2.

 

Emphasis

Using bold and italic styles can be an easy way to add emphasis to certain word or sentence. Use this to highlight some key points to your audience.

*This text will be italic*
_This will also be italic_

**This text will be bold**
__This will also be bold__

_You **can** combine them_

Example:

Some of the greatest discoveries happen by accident.

 

Lists

Lists are good when you have a whole bunch of items or points that you want to communicate to your audience. Lists can be ordered or unordered.

Unordered:

* This is your first item
* This is your second item
    * Use 2 spaces before the asterix to create sub points
    * Use 2 spaces before the asterix to create sub points

Ordered:

1. This is your first item
2. This is your second item
    1. Use 2 spaces before the asterix to create sub points
    2. Use 2 spaces before the asterix to create sub points

Example:

Unordered list

  • This is your first item
  • This is your second item
    • Use 2 spaces before the asterix to create sub points
    • Use 2 spaces before the asterix to create sub points

Ordered list

  1. This is your first item
  2. This is your second item
    1. Use 2 spaces before the asterix to create sub points
    2. Use 2 spaces before the asterix to create sub points
 

Images

Images allow you to add additional flare to your report. Whether it's a photograph, screenshot or a graph, images not only add visual interest but they can communicate so much that words can not.

![RapidReport logo](http://i.imgur.com/bPka2V1.png)

Format: ![Alt Text](url)

Follow the format structure to add images to your report. Your alt text should be concise and describe what your image is. Please note that you will need to upload your image to a place that will allow you to generate a URL for it.

Example:

 

Want to refer to an external source? Or maybe you would like to direct your audience to a campaign you're running? Links will let you do just that.

Simply add the url - https://www.rapidreport.io/markdown-guide

OR use the following format to add the link to a word or phrase

[RapidReport Markdown Guide](https://www.rapidreport.io/markdown-guide)

Format:: [Word or phrase](url)

Example:

The RapidReport website url is https://www.rapidreport.io/.

If you need help with formatting your reports, please check out the RapidReport Markdown Guide.