Metanorma AsciiRFC sample: The Holy Hand Grenade of Antioch
To check out Metanorma capabilities for IETF, take a look at the The Holy Hand Grenade of Antioch sample Metanorma project written in Metanorma for IETF/RFCs.
Obtain sample source for the document(s) here, and see the rendered form here.
You can use the sample as a starting point for authoring your own IETF documents with Metanorma. Refer to the repository for an overview of how the source is structured.
Working with the sample
Requirements
You will need Ruby, xml2rfc
and idnits
(for submission preflight) installed.
On macOS:
brew install idnits
brew install python
easy_install pip
pip install -r requirements.txt
gem install bundler
bundle install
Building
make all
Alternatively:
export ID_NAME=camelot-holy-grenade
make draft-${ID_NAME}.txt
Validating with idnits
idnits
is the tool for checking RFCs prior to submission.
export ID_NAME=camelot-holy-grenade
make draft-${ID_NAME}.nits
Note
|
The Makefile target infers the document name from the |
Iterating on your document
export ID_NAME=camelot-holy-grenade
make clean all; open draft-${ID_NAME}.txt