Get started

Get started

Metanorma installation, samples, customization & usage tips.

Choose your starting point

If you’d like to adopt Metanorma for your organization’s standard & specification management workflows, the best starting point is to customize an existing processor that matches your requirements best, such as Metanorma-ISO.

To author documents compliant with the requirements of certain established standard bodies, you may already find an existing Metanorma processor: see Metanorma’s officially supported document flavors

Quick install guide

Here is the simplest way to install Metanorma on any OS. This uses a Docker container, wrapping the Ruby gem and all dependencies such as Node, Puppeteer, and PlantUML.

Tip

If you would rather avoid using the Docker distribution, for performance reasons or otherwise, refer to a complete installation guide that covers different ways of getting Metanorma up and running.

Steps:

  1. Install Docker. Get the latest version for your operating system at https://docker.com/.

  2. Pull the container:

    docker pull ribose/metanorma

Now you should be able to run Metanorma executable like this:

docker run -v "$(pwd)":/metanorma/ -w /metanorma ribose/metanorma "metanorma -t {Metanorma flavor} -x {output formats} {my document filename}"
Note

To speed up document generation when using Metanorma in Docker, it is recommended to specify local-cache-only document attribute.

Write your first standard