mirror/json
1
0
Fork 0
mirror of https://github.com/nlohmann/json.git synced 2024-12-13 04:36:45 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
4fc7b3dc7c
json/doc
History
Niels Lohmann 4fc7b3dc7c
🔧 adjust docset generation script
2022-01-04 15:20:50 +01:00
..
docset 🔧 adjust docset generation script 2022-01-04 15:20:50 +01:00
examples 🔖 set version to 3.10.5 2022-01-02 22:35:35 +01:00
mkdocs 📝 improve documentation InputType and IteratorType (#3246) 2022-01-04 15:02:39 +01:00
usages 📝 listing projects using the library 2017-02-08 19:16:38 +01:00
avatars.png 🔖 set version to 3.10.5 2022-01-02 22:35:35 +01:00
index.md 🔖 set version to 3.10.5 2022-01-02 22:35:35 +01:00
json.gif 🔖 set version to 3.10.5 2022-01-02 22:35:35 +01:00
Makefile Consolidate documentation (#3071) 2021-12-29 13:41:01 +01:00
README.md Consolidate documentation (#3071) 2021-12-29 13:41: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.