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

The simplest way to install Metanorma on any OS is using Docker.

Tip

If you would rather avoid using Docker, such as for performance / access reasons, refer to the complete installation guide that covers different ways of setting up Metanorma.

Steps:

  1. Install Docker. Get the latest version for your operating system at the Docker website.

  2. Pull the container:

    docker pull metanorma/metanorma

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

Running the Metanorma container on macOS and Linux
docker run -v "$(pwd)":/metanorma/ -w /metanorma metanorma/metanorma metanorma compile -t {flavor} -x {output-formats} {my-document-path}
Running the Metanorma container on Windows
docker run -v "%cd%":/metanorma/ -w /metanorma metanorma/metanorma metanorma compile -t {flavor} -x {output-formats} {my-document-path}
Note

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