API

Markdown

Novem markdown comes in two flavours, simple and advanced.

Simple markdown includes everything all features listed below and can be used everywhere you use text on the novem platform. This includes chart and table data, configurations, as well as captions, titles, descriptions and names.

Advanced markdown extends simple markdown, adding more advanced features. Advanced markdown is only usable in document and e-mail content files.

Simple markdown is intended to allow you access to rich formatting features for your text.

Novem support 5 levels of headings denoted by the hash character in front of the text.

Markdown Result 
# Heading 1

## Heading 2

### Heading 3

#### Heading 4

##### Heading 5
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5

Novem also allows formatted and nested quotes using the > character.

Markdown Result 
> This is a quote
>
> > This is a double quote
> >
> > > This is a triple quote

This is a quote

This is a double quote

This is a triple quote

Markdown lists can be created using * to create unordered lists and 1. 2. etc to create ordered ones.

Markdown Result 
- item one
- item two
  - sub item two - one
  - sub item two - two
  • item one
  • item two
    • sub item two - one
    • sub item two - two
1. item one
2. item two
3. item three
  1. item one
  2. item two
  3. item three

Bold and italics are created with two and three * respectively.

Markdown Result 
It's easy to add **strong**,
_italic_ and **_strong italic_**
emphasis with markdown.

It's easy to add strong, italic and strong italic emphasis with markdown.

Markdown supports superscript and subscript formatting using ~ and ^^ respectively.

Markdown Result 
This is a ~superscript~ and a ^^subscript^^

This is a superscript and a subscript

With advanced markdown, novem is expanding on the more classic markdown syntax by adding blocks with special meaning. These blocks allow you to control additional aspects of your visualisation, for example by including plots in e-mails or pages in reports.

Novem markdown has a special multi line construct called a section. The section start with {'{{'} followed by a type. You can then provide a set of options in yaml format before closing the section with {'}}'}.

{'{{ section'}
  option name: value
{'}}'}

Examples of this would be page breaks, callouts, visualisations or images.

Some more complex sections allows both a start and closing section such as a callout, in this case the callout section is closed with a leading /.

example:

{'{{ callout'}
  type: warn
  border: none
{'}}'}

Content of the callout body in **markdown** format

{'{{ /callout }}'}
Next
Files