How to compile the documentation

The documentation of lnagb.js is a collection of Markdown files generated from the source code using jsdoc-to-markdown. It is a part of the lnagb.js website (the Markdown files are converted to HTML files in the website's build process). For whatever reason you want to compile the documentation, this page will help you out.

The source code of lnagb.js has docstrings which explain how each function works. These docstrings are converted to Markdown files using jsdoc-to-markdown, and when parsed by Jekyll, they are converted to HTML files that can be viewed in the web browser.

First, you need to clone the lnagb.js repository. The dev branch is the branch we will compile the documentation in, so you can choose to clone the branch only...

git clone --single-branch -b dev https://github.com/cszach/lnagb.js

...or clone the whole repository and then switch to the dev branch.

Now, move into the clone...

cd lnagb.js

...and install the dependencies.

npm install

Now you can compile the documentation by running:

npm run build-docs

This will build the documentation in docs/. If you need to rebuild the documentation, just run the command again, but it is recommended that you delete the docs folder before rebuilding.