mirror/json
1
0
Fork 0
mirror of https://github.com/nlohmann/json.git synced 2024-11-24 06:29:03 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
a87c1885cb
json/docs
History
Niels Lohmann 2d48a4d9c5
Add documentation for comparing json and ordered_json (#3599) 
* 📝 add documentation for #3443

* Apply suggestions from code review

Co-authored-by: Florian Albrechtskirchinger <falbrechtskirchinger@gmail.com>
2022-07-23 20:54:40 +02:00
..
docset 📝 clean up after #3581 (#3596) 2022-07-22 15:35:29 +02:00
examples Add documentation for comparing json and ordered_json (#3599) 2022-07-23 20:54:40 +02:00
mkdocs Add documentation for comparing json and ordered_json (#3599) 2022-07-23 20:54:40 +02:00
usages Reorganize directories (#3462) 2022-05-01 09:41:50 +02:00
avatars.png Reorganize directories (#3462) 2022-05-01 09:41:50 +02:00
index.md Reorganize directories (#3462) 2022-05-01 09:41:50 +02:00
json.gif Reorganize directories (#3462) 2022-05-01 09:41:50 +02:00
Makefile Reorganize directories (#3462) 2022-05-01 09:41:50 +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.