Docs

Quick Start

Quick start guide for creating a novem document.

Make sure you have a registered novem account and the novem cli installed.

To create a new novem document, use the novem cli with the create and doc flags (-C -d <doc_name>).

# create a novem document called quarterly_report
novem -d quarterly_report -C

The content of a novem document is written in novem flavoured markdown with extensions for pages, variables, spans and sections.

Create a local file with your content and write it to the document:

# write content from a file
cat report.md | novem -d quarterly_report

Documents support YAML frontmatter for metadata. Place it at the very beginning of your content between --- delimiters:

---
title: Quarterly Report
author: Analytics Team
date: January 2025
---
# Introduction

Your document content starts here.

Split your document into multiple pages using the {{ page }} section. Each page can have its own layout:

# First Page (portrait, default)

Content for the first page.

{{ page
orient: landscape
cols: 2
}}

## Second Page (landscape, 2 columns)

Content for the second page.

{{ page }}

## Third Page (default layout)

Content continues here.

Embed novem plots and grids directly in your document:

{{ vis
  ref: /u/novem_demo/p/nei_rgn_perf
  width: 100%
  align: center
  include title: true
  include caption: true
}}

Reference live values from your visualisations inline:

Revenue this quarter was {/u/acme/p/revenue/v/total} million,
up from {/u/acme/p/revenue/v/prev} last quarter.

Variables update automatically when the underlying data changes.

Share your document publicly or with specific users and groups:

# share with everyone
novem -d quarterly_report -w shared/public true

# share with a group
novem -d quarterly_report -w shared/+org~analytics true

Content of note.md:

---
title: Nordic Labour Markets
author: Research Team
---

# Overview

This note examines unemployment trends across the Nordic countries.

{{ vis
  ref: /u/novem_research/p/unemployment_nordics
  width: 100%
  include title: true
  include caption: true
}}

{{ callout
type: info
}}
All figures use the harmonised ILO definition for international
comparability.
{{ /callout }}

{{ page
orient: landscape
}}

## Regional Breakdown

| Country | Rate | Trend |
|---------|------|-------|
| Norway | 3.2% | Stable |
| Denmark | 4.8% | Improving |
| Sweden | 7.1% | Improving |
| Finland | 6.9% | Stable |

# create, add content and share
cat note.md | novem -d nordic_labour -C
novem -d nordic_labour -w shared/public true
Next
Content