This repository houses the source for json-everything documentation site, https://docs.json-everything.net.
We're happy to accept and review issues and PRs regarding the content of the documentation. As is the way of things, it can always be improved.
The API Reference docs are automatically generated by the ApiDocsGenerator tool the main repository and synced here. Changes to the API Reference docs should be made there.
The main project's CODE OF CONDUCT also applies.
The site is a standard Jekyll-based GitHub Pages site using a modified Chirpy theme.
You'll need to install the dependencies listed in the GitHub docs to run it locally. Once all of the dependencies are available, you can run the run.bat or run.sh scripts to more easily start up the site.
Because of the API docs, the building the entire site will take a few seconds, so running the site with an incremental build is recommended.
Please see the Chirpy theme site for examples of the markdown that's supported.
