Building Documentation

Jwno's documentation can be found in the doc directory in its source tree. It's written in Mendoza markup language. You can read the documentation online here, or render and deploy it locally.

Note: The documentation is work-in-progress. Some pages are missing, because I have not finished writing them yet 😅. The released documentation deployed to Github Pages is always for the latest Jwno release.

To deploy the docs locally, you need these:

  • Visurl Studio 2022 (The Community version will do.)
  • Janet (Preferably the latest release version.)
  • JPM

Then, follow these steps:

  1. Start an x64 Native Tools Command Prompt for VS 2022.
  2. Run jpm -l install mendoza in Jwno source directory.
  3. Run ..\jpm_tree\bin\mdz.bat in doc directory.
  4. Check out the built HTML pages in doc\site directory.

When the documentation source is updated, you only need to repeat step 3 to update the rendered HTML pages.