Markdown Basics

Cyver Core uses the formatting language “Markdown” to offer plain text formatting for Report Templates and some other functions. If you’re not familiar with Markdown, the following includes an overview of basic Markdown, which you might need to format your Report Templates.

Headers.

To create a header, simply put # in front of a word.

Markdown	Output
# Heading level 1	Heading level 1
## Heading level 2	Heading level 2
### Heading level 3	Heading level 3
#### Heading level 4	Heading level 4
##### Heading level 5	Heading level 5
###### Heading level 6	Heading level 6

Paragraphs

Markdown uses plain text paragraphs. Simply add spaces and line breaks in the text where desired to have them show up in the final Report.

Bold Text

Cyver Core offers built in text formatting. Use the formatting menu when editing your Report Template.

You can also format Bold text with markdown by adding two asterisks or two underscores to either side of the text.

Markdown	Output
This is bold text	This is bold text
This is __bold__ text	This is bold text

Italic Text

Cyver Core offers built in text formatting. Use the formatting menu when editing your Report Template to italicize text.

You can also italicize text using Markdown by writing an asterisk or an underscore to either side of the text.

Markdown	Output
This is italicized text	This is italicized text
This is _italicized_ text	This is italicized text

Bold and Italic Text

Cyver Core offers built in text formatting. Use the formatting menu when editing your Report Template to italicize and bold text.

You can also italicize and bold text using Markdown by writing three asterisks or underscore to either side of the text.

Markdown	Output
This is *bolded and italicized* text	This is *bolded and italicized* text
This is ___ bolded and italicized___ text	This is *bolded and italicized* text

Inserting Block Quotes

You can easily insert block quotes into Markdown by adding > in front of the text. Simply add an > at the start of every line you would like to be blank, including line breaks.

> this is block text

>that was a line break in a block

>>and this is a nested block quote

Horizontal Lines and Rules

To insert a horizontal line or rule, insert three asterisks (***), n-dashes (---), or underscores (___) on a line with no other text. Each of these options has the same output.

Inserting Links

Insert links into your report using either the Cyver Core toolbar, or Markdown. To share a link, simply enclose the hotlinked text in square brackets ([]) immediately followed by the URL in parentheses (). You may add text, which is visible when someone hovers a mouse over the linked text, by adding text bracketed with quotation marks into the parentheses bracket, after the URL.

[my hotlink text](www.Cyver.io).

[my hotlink text] (www.Cyver.io “with descriptive text”)

Inserting References

In some cases, you want to add links at the bottom of the report or file. To add this reference, enclose your linked text in square brackets, followed by a number in square brackets. These numbers should be consecutive, so that you can track how many references you have and which the person should be clicking on.

[text] [1]

[other text] [2]

[yet more text] [3]

Type the corresponding number, enclosed in square brackets followed by a colon. Type or paste the URL. You may surround this with angle brackets to hotlink it. You may also add a description with quotation marks.

[1]: cyver.io

[2]: <cyver.io>

[3] cyver.io “more descriptive text”

Linking URLs and Email Addresses

Quickly turn any text into a link by enclosing it in angle brackets.

<email@cyver.io>

<cyver.io>

Making Lists

Markdown supports several formatting options for creating lists. These include Asterisk (*), n-dash (-), and plus sign (+).

this is the first item of a list

This is the second item of the list

This is the third item

Increase the indent by hitting tab or hitting the spacebar 4 times
Numbered lists will automatically indent

Inserting Code

Insert code into reports using Grave accents, also known as Backticks or Back Quotes (`) on either side of the code. If the code includes Grave accents, enclose the phrase in double Grave accents. (``)

`<addr>`

Using Code Blocks

Press Tab or Hit the spacebar 4 times to create a code block.

<html>

<head>

</head>

</html>

Adding Images

You can upload images to your own server or from the web and share them in reports using Markdown. To do so, type ! followed by the image URL in parentheses.

!(Cyver/image/source/)

Alt Text: Add Alt Text in square brackets after the initial ! but before the image.

![this is a picture] (Cyver/image/source/)

Image Titles: Add an image title by typing text in quotation marks following the image URL:

![this is a picture] (Cyver/image/source/ “this picture has a name”)

Linked Images: Link the image by enclosing the image Markdown and any formatting in square brackets. Immediately add a link in parentheses.

[![this is a picture] (Cyver/image/source/ “this picture has a name”)] (Cyver.io)

Display Markdown Formatting as Text

Use characters like #, *, -, and others in Markdown without creating formatting by adding a backslash (\) in front of the character.

\* Not a bullet list

\# Not a header

\() not a link