Setting up Metanorma

The Metanorma command-line toolchain can be installed with any of the following installation methods suitable for your platform.

Platform-specific installation

Choose your platform:

• macOS

• Windows

• Linux

Platform-independent installation

The following installation methods are intended for skilled Metanorma experts who develop on Metanorma or require automated actions.

• Docker

  Tip	Installing via Docker Docker is a platform-independent container engine. The official Metanorma Docker containers on Docker Hub provide a simple and consistent to run Metanorma, especially on continuous integration (CI) environments.

• Ruby gem

  Tip

  Manual installation Assuming you know what you’re doing, the metanorma-cli gem can be manually installed. You will have to take care of dependencies: an appropriate Ruby version, plus other software depending on the end documents you’re building. Refer to Metanorma CLI installation docs for details.

Continuous delivery environments

Metanorma is often run on continuous integration (CI) and continuous deployment (CD) environments.

• GitHub Actions and GitLab CI/CD

Running Metanorma

Refer to the following documentation on how to run the metanorma command:

• Metanorma CLI manual for more details on its command options; and

• Using the Metanorma CLI for instructions on how to use Metanorma.