# Novem

> Novem is a data-visualisation platform for coders — create plots, documents, e-mails and dashboards through a simple file-and-path API.

The site at `https://novem.io` is the user-facing surface — sign-in, dashboard, content browsing and the documentation tree under `/docs`. The HTTP API is served from `https://api.novem.io` and described in its own service-description file.

## Documentation

The complete documentation rendered as a single Markdown file is at [novem.io/llms-full.txt](https://novem.io/llms-full.txt).

- **Get Started**
  - **Basics**
    - [Introduction](https://novem.io/docs/start/introduction.md) — Get started with novem. Sign up, connect the MCP server, and make your first live chart.
  - **Quick Starts**
    - [Plots](https://novem.io/docs/start/plot.md) — Create your first novem plot: a bar chart, from empty terminal to shareable URL.
    - [Documents](https://novem.io/docs/start/doc.md) — Quick start guide for creating a novem document.
    - [Mails](https://novem.io/docs/start/mail.md) — Quick start guide for creating a novem e-mail.
    - [Repos](https://novem.io/docs/start/repos.md) — Create your first novem repo and build it into a runnable image.
    - [Jobs](https://novem.io/docs/start/jobs.md) — Create your first novem job and run a repo image.
- **Guides**
  - **Products**
    - [Plots](https://novem.io/docs/guides/plot.md) — An overview of the novem plot.
    - [Documents](https://novem.io/docs/guides/doc.md) — An introduction to novem documents
    - [Mails](https://novem.io/docs/guides/mail.md) — An introduction to novem e-mail
    - [Repos](https://novem.io/docs/guides/repos.md) — An introduction to novem repos
    - [Jobs](https://novem.io/docs/guides/jobs.md) — An introduction to novem jobs
    - [Spaces](https://novem.io/docs/guides/spaces.md) — An introduction to novem spaces
  - **Platform**
    - [API](https://novem.io/docs/guides/api.md) — An introduction to the novem API
  - **Theming**
    - [Themes](https://novem.io/docs/guides/theme.md) — Customise the look and feel of your novem visualisation with a single set of primitives.
    - [Example](https://novem.io/docs/guides/theme/example.md) — A small custom.css that rebrands a doc and every plot embedded inside it.
  - **[Libraries](https://novem.io/docs/guides/libraries.md)** — Novem libraries
    - [CLI](https://novem.io/docs/guides/cli.md) — Command Line Interface - a simple shell utility to integrate novem with your existing shell scripts and workflows.
      - [Plot](https://novem.io/docs/guides/cli/plot.md) — Creating plots with the novem CLI
      - [Mail](https://novem.io/docs/guides/cli/mail.md) — Creating mails with the novem CLI
    - [Python](https://novem.io/docs/guides/python.md) — The novem python library.
- **Reference**
  - **API**
    - [Terminology](https://novem.io/docs/reference/api/terminology.md) — Standard novem terminology
    - [Authentication](https://novem.io/docs/reference/api/auth.md) — Logging in, tokens and the whoami endpoint
    - [Tags](https://novem.io/docs/reference/api/tags.md) — Highlight what you care about
    - [Social](https://novem.io/docs/reference/api/social.md) — Connecting and following other users
    - [Slicing](https://novem.io/docs/reference/api/slicing.md) — The novem slicing notation — one selector grammar across every config file.
    - [Vars](https://novem.io/docs/reference/api/vars.md) — Provide extra context
    - [Files](https://novem.io/docs/reference/api/files.md) — Input and output file formats provided by the novem API
    - [Sharing](https://novem.io/docs/reference/api/sharing.md) — How to share your visualisations using the novem api.
    - [Groups](https://novem.io/docs/reference/api/groups_and_orgs.md) — Creating groups and organisations
  - **[Markdown](https://novem.io/docs/reference/markdown/overview.md)** — The novem markdown format
    - [Sections](https://novem.io/docs/reference/markdown/sections.md) — The section grammar shared by novem documents and e-mails
    - [Paragraph](https://novem.io/docs/reference/markdown/paragraph.md) — Style paragraphs in your documents and e-mails
    - [Callouts](https://novem.io/docs/reference/markdown/callout.md) — Add callout boxes to your documents and e-mails
    - [Visualisation](https://novem.io/docs/reference/markdown/visualisations.md) — Embed novem visualisations in your documents and e-mails
    - [Images](https://novem.io/docs/reference/markdown/img.md) — Embed uploaded asset images in your documents and e-mails
    - [Preview](https://novem.io/docs/reference/markdown/preview.md) — Add preview text to your e-mails
    - [Authors](https://novem.io/docs/reference/markdown/author.md) — Add authors to your e-mails
    - [Pages](https://novem.io/docs/reference/markdown/page-breaks.md) — Control page breaks and layout in novem documents
    - [Page references](https://novem.io/docs/reference/markdown/page-refs.md) — Cross-reference the page a heading falls on with {pageref}
    - [Spans](https://novem.io/docs/reference/markdown/spans.md) — Add footnotes, references and colour spans to your documents
    - [Variables](https://novem.io/docs/reference/markdown/variables.md) — Embed live values in your documents
    - [HTML](https://novem.io/docs/reference/markdown/html.md) — Add raw HTML to your documents
    - [Comments](https://novem.io/docs/reference/markdown/comments.md) — Comment out text and sections with {{/* ... */}}
  - **[Plot](https://novem.io/docs/reference/plot/overview.md)** — The novem plot reference — config options, chart types, table plots and vars
    - [Config](https://novem.io/docs/reference/plot/config/overview.md) — Configuration and settings for novem plots
      - [Type](https://novem.io/docs/reference/plot/config/type.md) — How to change your novem plot type
      - [Title](https://novem.io/docs/reference/plot/config/title.md) — Add and style a tight two-line SVG title inside a novem plot
      - [Colors](https://novem.io/docs/reference/plot/config/colors.md) — How to change your chart and table colors.
      - [Table](https://novem.io/docs/reference/plot/config/table/overview.md) — How to format novem tables
        - [Border](https://novem.io/docs/reference/plot/config/table/border.md) — Control table border formatting
        - [Text](https://novem.io/docs/reference/plot/config/table/text.md) — Control table text styles, weights, sizes, and families
        - [Align](https://novem.io/docs/reference/plot/config/table/align.md) — Control table cell alignment
        - [Padding](https://novem.io/docs/reference/plot/config/table/padding.md) — Control table cell padding
        - [Format](https://novem.io/docs/reference/plot/config/table/format.md) — Control table cell number and text formatting
        - [Overflow](https://novem.io/docs/reference/plot/config/table/overflow.md) — Control table cell text overflow behavior
        - [Width](https://novem.io/docs/reference/plot/config/table/width.md) — Control table column widths
        - [Merge](https://novem.io/docs/reference/plot/config/table/merge.md) — Merge table cells for complex layouts
        - [Priority](https://novem.io/docs/reference/plot/config/table/priority.md) — Control responsive design priority for table rows and columns
        - [Chart](https://novem.io/docs/reference/plot/config/table/chart.md) — Add horizontal bar charts inside table cells
      - [Axis](https://novem.io/docs/reference/plot/config/axis.md) — One dense grammar for ticks, labels, gridlines, bands and titles
      - [Labels](https://novem.io/docs/reference/plot/config/labels.md) — Per-datapoint annotations
      - [Legend](https://novem.io/docs/reference/plot/config/legend.md) — How to add legends to your novem charts
      - [Margins](https://novem.io/docs/reference/plot/config/margins.md) — Surface margins and the panel gutter
    - [Charts](https://novem.io/docs/reference/plot/charts/overview.md) — How to use the novem API to create a bar chart.
      - [Bar](https://novem.io/docs/reference/plot/charts/bar.md) — How to use the novem API to create a bar chart.
      - [Custom](https://novem.io/docs/reference/plot/charts/custom.md) — How to use the novem API to create a bar chart.
    - [Tables](https://novem.io/docs/reference/plot/tables/overview.md) — Creating tables for your novem visuals.
      - [E-Mail Table](https://novem.io/docs/reference/plot/tables/mtable.md) — Creating tables for your novem e-mails.
    - [Vars](https://novem.io/docs/reference/plot/vars/overview.md) — Working with plot variables
  - **Documents**
    - [Content](https://novem.io/docs/reference/doc/content.md) — The content format for novem documents
    - [API](https://novem.io/docs/reference/doc/api.md) — The novem document API
  - **[Mails](https://novem.io/docs/reference/mail/overview.md)** — The novem e-mail API surface
    - [Content](https://novem.io/docs/reference/mail/content.md) — The content file for novem e-mails
    - [Recipients](https://novem.io/docs/reference/mail/recipients.md) — Novem e-mail recipients
    - [Config](https://novem.io/docs/reference/mail/config.md) — Configuration options for novem e-mails
    - [Sending](https://novem.io/docs/reference/mail/sending.md) — Trigger, test and track novem e-mail sends
    - [Renders](https://novem.io/docs/reference/mail/renders.md) — Rendered output formats for novem e-mails
  - **Grid**
    - [Layout](https://novem.io/docs/reference/grid/layout.md) — The grid layout and mapping file formats
    - [API](https://novem.io/docs/reference/grid/api.md) — The grid API endpoints
  - **Repos**
    - [API](https://novem.io/docs/reference/repos/api.md) — The repo API endpoints
  - **[Jobs](https://novem.io/docs/reference/jobs/overview.md)** — The novem jobs reference — chains, schedules, config and runs
    - [Chains](https://novem.io/docs/reference/jobs/chains.md) — Define a job's pipeline — one repo image, or several piped together.
    - [Schedule](https://novem.io/docs/reference/jobs/schedule.md) — Run a job automatically on a cron schedule.
    - [Config](https://novem.io/docs/reference/jobs/config.md) — Every job configuration key and metadata endpoint.
    - [Runs](https://novem.io/docs/reference/jobs/runs.md) — Trigger jobs and inspect what happened: logs, output, stats, and status.
  - **Spaces**
    - [API](https://novem.io/docs/reference/spaces/api.md) — The spaces API: every endpoint under /code/spaces.
  - **Theme**
    - [Colors](https://novem.io/docs/reference/theme/colors.md) — The novem color system — named colors, categorical and gradient palettes — and the --novem-* primitives a theme overrides.
    - [Typography](https://novem.io/docs/reference/theme/typography.md) — Font families, weights, sizes, line heights, letter spacing and numeric features exposed via --novem-* variables.
    - [Document](https://novem.io/docs/reference/theme/document.md) — Document-specific theme variables — tables, callouts, author byline, CTAs, cover, page header, footer, page numbers and document shape.
    - [Charts](https://novem.io/docs/reference/theme/charts.md) — Chart-specific theme variables — axes, gridlines, legend, tooltip, annotations, map, calendar, mtable, and shape preferences.
    - [Org themes](https://novem.io/docs/reference/theme/org-themes.md) — Publishing a reusable theme across an organisation with +org/yourorg.
  - **Python Library**
    - [Plot](https://novem.io/docs/reference/python/plot.md) — Using python to create novem plots, charts and tables
    - [Mail](https://novem.io/docs/reference/python/mail.md) — The novem python Mail class: construction styles, attributes, and the sections API
    - [Utilities](https://novem.io/docs/reference/python/utilities.md) — Using python to create novem plots, charts and tables
  - **[Profile](https://novem.io/docs/reference/profile/overview.md)** — Managing your novem profile.

## API

- [API service description](https://api.novem.io/llms.txt): The authoritative llms.txt for programmatic access, with auth, route conventions and discovery hints.
- [API landing page](https://api.novem.io/): Human-readable walkthrough of the API model.
- [API overview](https://novem.io/docs/guides/api): Concepts and worked examples.

## Account

- Account creation is currently invitation-only. Existing users can issue invites from [settings/invites](https://novem.io/settings/invites).
- [Tokens](https://novem.io/settings/tokens): Create, list and revoke API tokens.

## Tooling

- [Python client](https://pypi.org/project/novem/): `pip install novem`, then `novem --init` to log in.