Getting started with Metanorma on macOS

Install Metanorma via Homebrew

Homebrew is a popular package manager on macOS.

You will need to first install Homebrew; just run the one-line installation command given on Homebrew's landing page.

Then, run the following commands in Terminal.app:

brew install metanorma/metanorma/metanorma

Install Ruby

Note

This is only necessary for a developer installation of Metanorma.

While macOS provides a default installation of Ruby, it is restricted in a number of ways.

We strongly recommend installing a Ruby outside of the system Ruby using rbenv.

# Install Xcode and associated development tools
$ xcode-select --install
# Install GCC and development tools
$ brew install autoconf gcc make
# Install rbenv to manage Ruby versions
# Remember to follow the setup steps by running `rbenv init`!
$ curl -fsSL https://github.com/rbenv/rbenv-installer/raw/HEAD/bin/rbenv-installer | bash
# Install Ruby 3.4.7 through rbenv [or whatever the latest version is]
$ rbenv install 3.4.7
# Set Ruby 3.4.7 as your global version
$ rbenv global 3.4.7
# Then restart Terminal.app

Note

Very large documents may trigger a "Too many open files" error on macOS. A setting of ulimit -n 1024 on the shell is recommended to avoid this issue.

Edit this page on GitHub →