History

Niels Lohmann 1dfe4073e3 💚 fix documentation deploy		2023-11-01 22:09:53 +01:00
..
docset	Add migration guide (#3887 )	2022-12-18 17:04:23 +01:00
examples	Capture exceptions by const& in docs. (#4099 )	2023-09-23 17:19:50 +02:00
mkdocs	💚 fix documentation deploy	2023-11-01 22:09:53 +01:00
usages	Reorganize directories (#3462 )	2022-05-01 09:41:50 +02:00
avatars.png	🔖 set version to 3.11.2	2022-08-12 15:04:06 +02:00
json.gif	🔖 set version to 3.11.2	2022-08-12 15:04:06 +02:00
Makefile	Move UDLs out of the global namespace (#3605 )	2022-07-31 17:38:52 +02:00
README.md	Reorganize directories (#3462 )	2022-05-01 09:41:50 +02: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 docs/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.