Skip to content

Commit 0f9e6ae

Browse files
authored
Fix broken links (#4605)
Signed-off-by: Niels Lohmann <[email protected]>
1 parent 8a882f3 commit 0f9e6ae

File tree

4 files changed

+50
-46
lines changed

4 files changed

+50
-46
lines changed

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![Windows](https://github.com/nlohmann/json/workflows/Windows/badge.svg)](https://github.com/nlohmann/json/actions?query=workflow%3AWindows)
77
[![Coverage Status](https://coveralls.io/repos/github/nlohmann/json/badge.svg?branch=develop)](https://coveralls.io/github/nlohmann/json?branch=develop)
88
[![Coverity Scan Build Status](https://scan.coverity.com/projects/5550/badge.svg)](https://scan.coverity.com/projects/nlohmann-json)
9-
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/e0d1a9d5d6fd46fcb655c4cb930bb3e8)](https://www.codacy.com/gh/nlohmann/json/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=nlohmann/json&amp;utm_campaign=Badge_Grade)
9+
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/e0d1a9d5d6fd46fcb655c4cb930bb3e8)](https://app.codacy.com/gh/nlohmann/json/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
1010
[![Cirrus CI](https://api.cirrus-ci.com/github/nlohmann/json.svg)](https://cirrus-ci.com/github/nlohmann/json)
1111
[![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/json.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:json)
1212
[![Try online](https://img.shields.io/badge/try-online-blue.svg)](https://wandbox.org/permlink/1mp10JbaANo6FUc7)
@@ -61,7 +61,7 @@ There are myriads of [JSON](https://json.org) libraries out there, and each may
6161

6262
- **Trivial integration**. Our whole code consists of a single header file [`json.hpp`](https://github.com/nlohmann/json/blob/develop/single_include/nlohmann/json.hpp). That's it. No library, no subproject, no dependencies, no complex build system. The class is written in vanilla C++11. All in all, everything should require no adjustment of your compiler flags or project settings. The library is also included in all popular [package managers](https://json.nlohmann.me/integration/package_managers/).
6363

64-
- **Serious testing**. Our code is heavily [unit-tested](https://github.com/nlohmann/json/tree/develop/tests/src) and covers [100%](https://coveralls.io/r/nlohmann/json) of the code, including all exceptional behavior. Furthermore, we checked with [Valgrind](https://valgrind.org) and the [Clang Sanitizers](https://clang.llvm.org/docs/index.html) that there are no memory leaks. [Google OSS-Fuzz](https://github.com/google/oss-fuzz/tree/master/projects/json) additionally runs fuzz tests against all parsers 24/7, effectively executing billions of tests so far. To maintain high quality, the project is following the [Core Infrastructure Initiative (CII) best practices](https://bestpractices.coreinfrastructure.org/projects/289). See the [quality assurance](https://json.nlohmann.me/integration/community/quality_assurance) overview documentation.
64+
- **Serious testing**. Our code is heavily [unit-tested](https://github.com/nlohmann/json/tree/develop/tests/src) and covers [100%](https://coveralls.io/r/nlohmann/json) of the code, including all exceptional behavior. Furthermore, we checked with [Valgrind](https://valgrind.org) and the [Clang Sanitizers](https://clang.llvm.org/docs/index.html) that there are no memory leaks. [Google OSS-Fuzz](https://github.com/google/oss-fuzz/tree/master/projects/json) additionally runs fuzz tests against all parsers 24/7, effectively executing billions of tests so far. To maintain high quality, the project is following the [Core Infrastructure Initiative (CII) best practices](https://bestpractices.coreinfrastructure.org/projects/289). See the [quality assurance](https://json.nlohmann.me/community/quality_assurance) overview documentation.
6565

6666
Other aspects were not so important to us:
6767

@@ -101,7 +101,7 @@ Thanks everyone!
101101

102102
:question: If you have a **question**, please check if it is already answered in the [**FAQ**](https://json.nlohmann.me/home/faq/) or the [**Q&A**](https://github.com/nlohmann/json/discussions/categories/q-a) section. If not, please [**ask a new question**](https://github.com/nlohmann/json/discussions/new) there.
103103

104-
:books: If you want to **learn more** about how to use the library, check out the rest of the [**README**](#examples), have a look at [**code examples**](https://github.com/nlohmann/json/tree/develop/docs/examples), or browse through the [**help pages**](https://json.nlohmann.me).
104+
:books: If you want to **learn more** about how to use the library, check out the rest of the [**README**](#examples), have a look at [**code examples**](https://github.com/nlohmann/json/tree/develop/docs/mkdocs/docs/examples), or browse through the [**help pages**](https://json.nlohmann.me).
105105

106106
:construction: If you want to understand the **API** better, check out the [**API Reference**](https://json.nlohmann.me/api/basic_json/) or have a look at the [quick reference](#quick-reference) below.
107107

@@ -139,7 +139,7 @@ Here are some examples to give you an idea how to use the class.
139139
Beside the examples below, you may want to:
140140

141141
→ Check the [documentation](https://json.nlohmann.me/)\
142-
→ Browse the [standalone example files](https://github.com/nlohmann/json/tree/develop/docs/examples)\
142+
→ Browse the [standalone example files](https://github.com/nlohmann/json/tree/develop/docs/mkdocs/docs/examples)\
143143
→ Read the full [API Documentation](https://json.nlohmann.me/api/basic_json/) with self-contained examples for every function
144144

145145
### Read JSON from a file
@@ -1289,20 +1289,20 @@ endif()
12891289

12901290
Use your favorite [**package manager**](https://json.nlohmann.me/integration/package_managers/) to use the library.
12911291

1292-
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/cleanup/docs/mkdocs/docs/images/package_managers/homebrew.svg" height="20">&nbsp;[**Homebrew**](https://json.nlohmann.me/integration/package_managers/#homebrew) `nlohmann-json`
1293-
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/cleanup/docs/mkdocs/docs/images/package_managers/meson.svg" height="20">&nbsp;[**Meson**](https://json.nlohmann.me/integration/package_managers/#meson) `nlohmann_json`
1294-
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/cleanup/docs/mkdocs/docs/images/package_managers/bazel.svg" height="20">&nbsp;[**Bazel**](https://json.nlohmann.me/integration/package_managers/#bazel) `nlohmann_json`
1295-
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/cleanup/docs/mkdocs/docs/images/package_managers/conan.svg" height="20">&nbsp;[**Conan**](https://json.nlohmann.me/integration/package_managers/#conan) `nlohmann_json`
1296-
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/cleanup/docs/mkdocs/docs/images/package_managers/spack.svg" height="20">&nbsp;[**Spack**](https://json.nlohmann.me/integration/package_managers/#spack) `nlohmann-json`
1292+
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/homebrew.svg" height="20">&nbsp;[**Homebrew**](https://json.nlohmann.me/integration/package_managers/#homebrew) `nlohmann-json`
1293+
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/meson.svg" height="20">&nbsp;[**Meson**](https://json.nlohmann.me/integration/package_managers/#meson) `nlohmann_json`
1294+
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/bazel.svg" height="20">&nbsp;[**Bazel**](https://json.nlohmann.me/integration/package_managers/#bazel) `nlohmann_json`
1295+
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/conan.svg" height="20">&nbsp;[**Conan**](https://json.nlohmann.me/integration/package_managers/#conan) `nlohmann_json`
1296+
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/spack.svg" height="20">&nbsp;[**Spack**](https://json.nlohmann.me/integration/package_managers/#spack) `nlohmann-json`
12971297
- [**Hunter**](https://json.nlohmann.me/integration/package_managers/#hunter) `nlohmann_json`
1298-
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/cleanup/docs/mkdocs/docs/images/package_managers/vcpkg.png" height="20">&nbsp;[**vcpkg**](https://json.nlohmann.me/integration/package_managers/#vcpkg) `nlohmann-json`
1298+
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/vcpkg.png" height="20">&nbsp;[**vcpkg**](https://json.nlohmann.me/integration/package_managers/#vcpkg) `nlohmann-json`
12991299
- [**cget**](https://json.nlohmann.me/integration/package_managers/#cget) `nlohmann/json`
1300-
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/cleanup/docs/mkdocs/docs/images/package_managers/swift.svg" height="20">&nbsp;[**Swift Package Manager**](https://json.nlohmann.me/integration/package_managers/#swift-package-manager) `nlohmann/json`
1301-
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/cleanup/docs/mkdocs/docs/images/package_managers/nuget.svg" height="20">&nbsp;[**Nuget**](https://json.nlohmann.me/integration/package_managers/#nuget) `nlohmann.json`
1302-
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/cleanup/docs/mkdocs/docs/images/package_managers/conda.svg" height="20">&nbsp;[**Conda**](https://json.nlohmann.me/integration/package_managers/#conda) `nlohmann_json`
1303-
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/cleanup/docs/mkdocs/docs/images/package_managers/macports.svg" height="20">&nbsp;[**MacPorts**](https://json.nlohmann.me/integration/package_managers/#macports) `nlohmann-json`
1304-
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/cleanup/docs/mkdocs/docs/images/package_managers/CPM.png" height="20">&nbsp;[**cpm.cmake**](https://json.nlohmann.me/integration/package_managers/#cpmcmake) `gh:nlohmann/json`
1305-
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/cleanup/docs/mkdocs/docs/images/package_managers/xmake.svg" height="20">&nbsp;[**xmake**](https://json.nlohmann.me/integration/package_managers/#xmake) `nlohmann_json`
1300+
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/swift.svg" height="20">&nbsp;[**Swift Package Manager**](https://json.nlohmann.me/integration/package_managers/#swift-package-manager) `nlohmann/json`
1301+
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/nuget.svg" height="20">&nbsp;[**Nuget**](https://json.nlohmann.me/integration/package_managers/#nuget) `nlohmann.json`
1302+
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/conda.svg" height="20">&nbsp;[**Conda**](https://json.nlohmann.me/integration/package_managers/#conda) `nlohmann_json`
1303+
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/macports.svg" height="20">&nbsp;[**MacPorts**](https://json.nlohmann.me/integration/package_managers/#macports) `nlohmann-json`
1304+
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/CPM.png" height="20">&nbsp;[**cpm.cmake**](https://json.nlohmann.me/integration/package_managers/#cpmcmake) `gh:nlohmann/json`
1305+
- <img src="https://raw.githubusercontent.com/nlohmann/json/refs/heads/develop/docs/mkdocs/docs/images/package_managers/xmake.svg" height="20">&nbsp;[**xmake**](https://json.nlohmann.me/integration/package_managers/#xmake) `nlohmann_json`
13061306

13071307
The library is part of many package managers. See the [**documentation**](https://json.nlohmann.me/integration/package_managers/) for detailed descriptions and examples.
13081308

@@ -1477,7 +1477,7 @@ I deeply appreciate the help of the following people.
14771477
115. [Matthias Möller](https://github.com/TinyTinni) removed the dependency from `std::stringstream`.
14781478
116. [agrianius](https://github.com/agrianius) added code to use alternative string implementations.
14791479
117. [Daniel599](https://github.com/Daniel599) allowed to use more algorithms with the `items()` function.
1480-
118. [Julius Rakow](https://github.com/jrakow) fixed the Meson include directory and fixed the links to [cppreference.com](cppreference.com).
1480+
118. [Julius Rakow](https://github.com/jrakow) fixed the Meson include directory and fixed the links to [cppreference.com](https://cppreference.com).
14811481
119. [Sonu Lohani](https://github.com/sonulohani) fixed the compilation with MSVC 2015 in debug mode.
14821482
120. [grembo](https://github.com/grembo) fixed the test suite and re-enabled several test cases.
14831483
121. [Hyeon Kim](https://github.com/simnalamburt) introduced the macro `JSON_INTERNAL_CATCH` to control the exception handling inside the library.
@@ -1719,15 +1719,15 @@ The library itself consists of a single header file licensed under the MIT licen
17191719
- [**Artistic Style**](http://astyle.sourceforge.net) for automatic source code indentation
17201720
- [**Clang**](https://clang.llvm.org) for compilation with code sanitizers
17211721
- [**CMake**](https://cmake.org) for build automation
1722-
- [**Codacy**](https://www.codacy.com) for further [code analysis](https://www.codacy.com/app/nlohmann/json)
1722+
- [**Codacy**](https://www.codacy.com) for further [code analysis](https://app.codacy.com/gh/nlohmann/json/dashboard)
17231723
- [**Coveralls**](https://coveralls.io) to measure [code coverage](https://coveralls.io/github/nlohmann/json)
17241724
- [**Coverity Scan**](https://scan.coverity.com) for [static analysis](https://scan.coverity.com/projects/nlohmann-json)
17251725
- [**cppcheck**](http://cppcheck.sourceforge.net) for static analysis
17261726
- [**doctest**](https://github.com/onqtam/doctest) for the unit tests
17271727
- [**GitHub Changelog Generator**](https://github.com/skywinder/github-changelog-generator) to generate the [ChangeLog](https://github.com/nlohmann/json/blob/develop/ChangeLog.md)
17281728
- [**Google Benchmark**](https://github.com/google/benchmark) to implement the benchmarks
17291729
- [**Hedley**](https://nemequ.github.io/hedley/) to avoid re-inventing several compiler-agnostic feature macros
1730-
- [**lcov**](http://ltp.sourceforge.net/coverage/lcov.php) to process coverage information and create an HTML view
1730+
- [**lcov**](https://github.com/linux-test-project/lcov) to process coverage information and create an HTML view
17311731
- [**libFuzzer**](https://llvm.org/docs/LibFuzzer.html) to implement fuzz testing for OSS-Fuzz
17321732
- [**Material for MkDocs**](https://squidfunk.github.io/mkdocs-material/) for the style of the documentation site
17331733
- [**MkDocs**](https://www.mkdocs.org) for the documentation site
@@ -1825,4 +1825,4 @@ Some tests change the installed files and hence make the whole process not repro
18251825

18261826
Note you need to call `cmake -LE "not_reproducible|git_required"` to exclude both labels. See [issue #2596](https://github.com/nlohmann/json/issues/2596) for more information.
18271827

1828-
As Intel compilers use unsafe floating point optimization by default, the unit tests may fail. Use flag [`/fp:precise`](https://software.intel.com/content/www/us/en/develop/documentation/cpp-compiler-developer-guide-and-reference/top/compiler-reference/compiler-options/compiler-option-details/floating-point-options/fp-model-fp.html) then.
1828+
As Intel compilers use unsafe floating point optimization by default, the unit tests may fail. Use flag [`/fp:precise`](https://www.intel.com/content/www/us/en/docs/cpp-compiler/developer-guide-reference/2021-8/fp-model-fp.html) then.

docs/mkdocs/Makefile

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,14 @@ build: style_check
1313
style_check:
1414
@cd docs ; ../venv/bin/python3 ../scripts/check_structure.py
1515

16-
# check the links in the documentation
16+
# check the links in the documentation files in docs/mkdocs
1717
link_check:
1818
ENABLED_HTMLPROOFER=true venv/bin/mkdocs build
1919

20+
# check the links in all other Markdown files
21+
link_check_markdowns:
22+
npx markdown-link-check --progress --alive 200,429 ../../README.md ../../FILES.md ../../.github/*.md
23+
2024
# publish site to GitHub pages (not working in GitHub Actions; need special action)
2125
publish:
2226
venv/bin/mkdocs gh-deploy --clean --force

docs/mkdocs/docs/api/basic_json/to_bjdata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The exact mapping and its limitations is described on a [dedicated page](../../f
4040
`#!cpp false` by default.
4141
4242
`version` (in)
43-
: which version of BJData to use (see [draft 3](../../features/binary_formats/bjdata.md#draft-3-binary-format));
43+
: which version of BJData to use (see note on "Binary values" on [BJData](../../features/binary_formats/bjdata.md));
4444
optional, `#!cpp bjdata_version_t::draft2` by default.
4545
4646
## Return value

docs/mkdocs/docs/features/binary_formats/bjdata.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -164,30 +164,30 @@ The library uses the following mapping from JSON values types to BJData types ac
164164

165165
The library maps BJData types to JSON value types as follows:
166166

167-
| BJData type | JSON value type | marker |
168-
|-------------|-----------------------------------------|--------|
169-
| no-op | *no value, next value is read* | `N` |
170-
| null | `null` | `Z` |
171-
| false | `false` | `F` |
172-
| true | `true` | `T` |
173-
| float16 | number_float | `h` |
174-
| float32 | number_float | `d` |
175-
| float64 | number_float | `D` |
176-
| uint8 | number_unsigned | `U` |
177-
| int8 | number_integer | `i` |
178-
| uint16 | number_unsigned | `u` |
179-
| int16 | number_integer | `I` |
180-
| uint32 | number_unsigned | `m` |
181-
| int32 | number_integer | `l` |
182-
| uint64 | number_unsigned | `M` |
183-
| int64 | number_integer | `L` |
184-
| byte | number_unsigned | `B` |
185-
| string | string | `S` |
186-
| char | string | `C` |
187-
| array | array (optimized values are supported) | `[` |
188-
| ND-array | object (in JData annotated array format)|`[$.#[.`|
189-
| object | object (optimized values are supported) | `{` |
190-
| binary | binary (strongly-typed byte array) | `[$B` |
167+
| BJData type | JSON value type | marker |
168+
|-------------|------------------------------------------|----------|
169+
| no-op | *no value, next value is read* | `N` |
170+
| null | `null` | `Z` |
171+
| false | `false` | `F` |
172+
| true | `true` | `T` |
173+
| float16 | number_float | `h` |
174+
| float32 | number_float | `d` |
175+
| float64 | number_float | `D` |
176+
| uint8 | number_unsigned | `U` |
177+
| int8 | number_integer | `i` |
178+
| uint16 | number_unsigned | `u` |
179+
| int16 | number_integer | `I` |
180+
| uint32 | number_unsigned | `m` |
181+
| int32 | number_integer | `l` |
182+
| uint64 | number_unsigned | `M` |
183+
| int64 | number_integer | `L` |
184+
| byte | number_unsigned | `B` |
185+
| string | string | `S` |
186+
| char | string | `C` |
187+
| array | array (optimized values are supported) | `[` |
188+
| ND-array | object (in JData annotated array format) | `[$.#[.` |
189+
| object | object (optimized values are supported) | `{` |
190+
| binary | binary (strongly-typed byte array) | `[$B` |
191191

192192
!!! success "Complete mapping"
193193

0 commit comments

Comments
 (0)