History

Niels Lohmann b9a4a4809c 🚸 add examples		2021-11-07 22:07:16 +01:00
..
docset	Update docset generation script (#2967 )	2021-09-01 08:43:10 +02:00
examples	🚸 add examples	2021-11-07 22:07:16 +01:00
mkdocs	🚸 add examples	2021-11-07 22:07:16 +01:00
usages	📝 listing projects using the library	2017-02-08 19:16:38 +01:00
avatars.png	🔖 set version to 3.10.1	2021-08-24 20:19:55 +02:00
index.md	🔖 set version to 3.10.4	2021-10-16 13:34:31 +02:00
json.gif	🔖 set version to 3.10.4	2021-10-16 13:34:31 +02:00
Makefile	🔥 consolidate documentation	2021-10-10 15:12:26 +02:00
README.md	📝 document documentation generation	2021-11-07 20:17:01 +01:00

README.md

Documentation

Generate documentation

Note on documentation: The source files contain links to the online documentation at https://json.nlohmann.me. This URL contains the most recent documentation and should also be applicable to previous versions; documentation for deprecated functions is not removed, but marked deprecated.

If you want to see the documentation for a specific tag or commit hash, you can generate it as follows (here for tag v3.10.2):

git clone https://github.com/nlohmann/json.git
cd json
git checkout v3.10.2
make install_venv serve -C doc/mkdocs

Open URL http://127.0.0.1:8000/ in your browser. Replace from any URL from the source code https://json.nlohmann.me with http://127.0.0.1:8000 to see the documentation for your tag or commit hash.