Nano Markup

Tutorial

Learn Nano Markup.

Nano Markup has three value types and a small set of syntax rules. This tutorial shows the practical basics for writing and reading a .nano file.

Basics

Start with mappings and sequences

A document can be a string, a mapping, or a sequence. A simple value stays on the same line as its key, such as title Project notes. A root mapping begins with .., a root sequence begins with :, and nested values use exactly four spaces per level.

..
    title Project notes
    tags:
        release
        documentation
    owner..
        name Ariana
        team Tools

Text

Use block strings for multiline text

Use | when a value spans multiple lines. The following indented lines are joined into one string, preserving the line breaks. The block body is indented one level deeper than the key, while the next value returns to the key's indentation.

..
    summary|
        Nano Markup is small.
        It keeps plain text readable.
    status stable

Next

Read the exact rules when implementing

The tutorial is a starting point. The stable specification defines the exact grammar, data model, conformance requirements, and error behavior for parser and writer implementations.

Open the Nano Markup 1.0.0 specification →

Continue with practical examples or read the FAQ.