DEPRECATED: Generating documentation using a "generic flavour" of Metanorma

Prerequisites

• Docker
• This repository

Setup

• Refer to https://github.com/agiorguk/gemini/wiki/Notes-on-testing-metanorma for advice on generating the asciidoc files if necessary (noting in particular the requirement for the :customize: metanorma.yml statement under the title, where the leading space is important).
• Move the asciidoc files that you wish to convert into the metanorma directory.
• Make any changes that you wish to make in metanorma\metanorma.yml (see https://www.metanorma.org/builder/topics/simple-adoption/ for reference)
• Whatever else you do, don't move/rename/delete the three css files in that directory unless you change the volume mount parameters (-v) in the docker command below

Conversion to asciidoc

You can use the docker image for pandoc as follows, substituting your input filename in place of {inputfile}:

docker run --rm --volume "$(pwd):/data" --user $(id -u):$(id -g) pandoc/core {inputfile} -o {inputfile}.adoc

Then copy {inputfile}.adoc to the metanorma directory to follow the instructions below.

Running

Run the following docker command from inside the metanorma directory, substituting the filename in place of {yourfile}:

docker run -it \
-v "$(pwd)":/metanorma/ \
-v generic.css:/usr/local/bundle/gems/metanorma-generic-1.11.1/lib/isodoc/generic/html/generic.css \
-v wordstyle.css:/usr/local/bundle/gems/metanorma-generic-1.11.1/lib/isodoc/generic/html/wordstyle.css \
-v htmlstyle.css:/usr/local/bundle/gems/metanorma-generic-1.11.1/lib/isodoc/generic/html/htmlstyle.css \
-w /metanorma metanorma/mn:latest \
metanorma compile -t generic \
-x html {yourfile}.adoc

Troubleshooting

Errors and warning messages will be output to the command line, along with a .err file inside the metanorma directory.

Output

The output html and xml files will also be in the metanorma directory.