mirror of
https://github.com/nlohmann/json.git
synced 2026-10-10 16:37:14 +00:00
Niels Lohmann
fc32fb6aed
- REUSE.toml: fix the Hedley path and SPDX id (CC0-1.0), mark the docset icons as the public-domain JSON logo - CITATION.cff: v3.12.0 was released on 2025-04-11 - FILES.md: list all workflows, describe the Meson option defaults - README: ctest -LE, table of contents, typos, stale Android/MinGW advice, moved links, merge duplicate Thanks entries, list the analysis tools used in CI - CONTRIBUTING: iterative parser, json_literals.hpp is generated, links - .gitignore: backups and release outputs; .gitattributes: mark generated files - labeler: label other build systems and .github documentation - MODULE.bazel: add the module version Signed-off-by: Niels Lohmann <mail@nlohmann.me>
24 lines
829 B
Markdown
24 lines
829 B
Markdown
# Documentation
|
|
|
|
## Generate documentation
|
|
|
|
Note on documentation: The source files contain links to the online documentation at https://json.nlohmann.me.
|
|
This URL provides the most recent documentation and also applies to previous versions. Documentation for deprecated
|
|
functions is not removed; instead, it is marked as deprecated.
|
|
|
|
If you want to view the documentation for a specific tag or commit hash, you can generate it locally as follows (example
|
|
using tag `v3.12.0`):
|
|
|
|
```shell
|
|
git clone https://github.com/nlohmann/json.git
|
|
cd json
|
|
git checkout v3.12.0
|
|
make install_venv serve -C docs/mkdocs
|
|
```
|
|
|
|
Open <http://127.0.0.1:8000/> in your browser. Replace any URL in the source code that points to
|
|
`https://json.nlohmann.me` with `http://127.0.0.1:8000` to view the documentation for the selected tag or commit hash.
|
|
|
|
|
|
|