mirror of
https://github.com/nlohmann/json.git
synced 2026-10-12 10:13:13 +00:00
satelliteprogrammer
40a62947d3
* support JSON Merge Patch (RFC 7396) diff creation The JSON merge patch document format describes the set of modifications to a resource's content, that more closely mimics the syntax of the resource being modified. However, and in contrast to JSON Patch (RFC 6902), a JSON Merge Patch cannot express certain modifications, e.g., changing an array element at a specific index, or setting a specific object value to null. The null value in a JSON Merge Patch is used to remove the key from the object. The diff algorithm is not part of the RFC 7396, but it was tested against all examples provided, plus additional cases on how null values are handled. Signed-off-by: Luís Murta <luis@murta.dev> * improve algorithm efficiency Signed-off-by: Luís Murta <luis@murta.dev> * fix inconsistent nulls and empty arrays Also add CHECKs for the patch, documentation and run `make amalgamate`. Signed-off-by: Luís Murta <luis@murta.dev> * documentation cleanups Signed-off-by: Luís Murta <luis@murta.dev> * add an iterative fallback to merge_diff Bound the recursion depth like diff() and merge_patch(), and test values nested past the bound. Signed-off-by: Luís Murta <luis@murta.dev> * address the remaining review comments Signed-off-by: Luís Murta <luis@murta.dev> * move multi-line raw strings out of CHECK macros GCC 4.8/5, ICPC and NVHPC mis-tokenize multi-line raw string literals inside macro arguments, breaking the build or the parsed JSON. Signed-off-by: Luís Murta <luis@murta.dev> --------- Signed-off-by: Luís Murta <luis@murta.dev>
488 lines
23 KiB
YAML
488 lines
23 KiB
YAML
# Project information
|
|
site_name: JSON for Modern C++
|
|
site_author: Niels Lohmann
|
|
site_url: https://json.nlohmann.me/
|
|
|
|
# Repository
|
|
repo_name: nlohmann/json
|
|
repo_url: https://github.com/nlohmann/json
|
|
edit_uri: edit/develop/docs/mkdocs/docs
|
|
|
|
# Copyright
|
|
copyright: Copyright © 2013-2026 Niels Lohmann
|
|
|
|
# Configuration
|
|
theme:
|
|
name: material
|
|
language: en
|
|
palette:
|
|
- media: '(prefers-color-scheme: light)'
|
|
scheme: default
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- media: '(prefers-color-scheme: dark)'
|
|
scheme: slate
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
font:
|
|
text: Roboto
|
|
code: JetBrains Mono
|
|
features:
|
|
- navigation.instant
|
|
- navigation.tracking
|
|
- navigation.tabs
|
|
- navigation.indexes
|
|
- navigation.top
|
|
- content.tabs.link
|
|
- content.action.edit
|
|
- content.action.view
|
|
|
|
nav:
|
|
- Home:
|
|
- index.md
|
|
- home/license.md
|
|
- "FAQ": home/faq.md
|
|
- home/exceptions.md
|
|
- home/releases.md
|
|
- home/design_goals.md
|
|
- home/architecture.md
|
|
- home/customers.md
|
|
- home/sponsors.md
|
|
- home/debugging.md
|
|
- Features:
|
|
- features/index.md
|
|
- features/arbitrary_types.md
|
|
- Binary Formats:
|
|
- features/binary_formats/index.md
|
|
- features/binary_formats/bjdata.md
|
|
- features/binary_formats/bon8.md
|
|
- features/binary_formats/bson.md
|
|
- features/binary_formats/cbor.md
|
|
- features/binary_formats/messagepack.md
|
|
- features/binary_formats/ubjson.md
|
|
- features/binary_values.md
|
|
- features/comments.md
|
|
- features/conversions.md
|
|
- features/creating_values.md
|
|
- Element Access:
|
|
- features/element_access/index.md
|
|
- features/element_access/unchecked_access.md
|
|
- features/element_access/checked_access.md
|
|
- features/element_access/default_value.md
|
|
- features/iterators.md
|
|
- features/merge_patch.md
|
|
- features/json_patch.md
|
|
- features/json_pointer.md
|
|
- features/modifying_values.md
|
|
- features/modules.md
|
|
- 'nlohmann Namespace': features/namespace.md
|
|
- features/object_order.md
|
|
- features/performance.md
|
|
- Parsing:
|
|
- features/parsing/index.md
|
|
- features/parsing/json_lines.md
|
|
- features/parsing/parse_exceptions.md
|
|
- features/parsing/parser_callbacks.md
|
|
- features/parsing/sax_interface.md
|
|
- features/parsing/untrusted_input.md
|
|
- features/assertions.md
|
|
- features/serialization.md
|
|
- features/enum_conversion.md
|
|
- features/macros.md
|
|
- features/trailing_commas.md
|
|
- Types:
|
|
- features/types/index.md
|
|
- features/types/number_handling.md
|
|
- features/types/template_parameters.md
|
|
- Integration:
|
|
- integration/index.md
|
|
- integration/migration_guide.md
|
|
- integration/cmake.md
|
|
- integration/package_managers.md
|
|
- integration/pkg-config.md
|
|
- integration/compile_times.md
|
|
- API Documentation:
|
|
- basic_json:
|
|
- 'Overview': api/basic_json/index.md
|
|
- '(Constructor)': api/basic_json/basic_json.md
|
|
- '(Destructor)': api/basic_json/~basic_json.md
|
|
- 'accept': api/basic_json/accept.md
|
|
- 'array': api/basic_json/array.md
|
|
- 'array_t': api/basic_json/array_t.md
|
|
- 'as_base_class': api/basic_json/as_base_class.md
|
|
- 'at': api/basic_json/at.md
|
|
- 'back': api/basic_json/back.md
|
|
- 'begin': api/basic_json/begin.md
|
|
- 'binary': api/basic_json/binary.md
|
|
- 'binary_t': api/basic_json/binary_t.md
|
|
- 'boolean_t': api/basic_json/boolean_t.md
|
|
- 'cbegin': api/basic_json/cbegin.md
|
|
- 'cbor_tag_handler_t': api/basic_json/cbor_tag_handler_t.md
|
|
- 'cend': api/basic_json/cend.md
|
|
- 'clear': api/basic_json/clear.md
|
|
- 'contains': api/basic_json/contains.md
|
|
- 'count': api/basic_json/count.md
|
|
- 'crbegin': api/basic_json/crbegin.md
|
|
- 'crend': api/basic_json/crend.md
|
|
- 'default_object_comparator_t': api/basic_json/default_object_comparator_t.md
|
|
- 'diff': api/basic_json/diff.md
|
|
- 'dump': api/basic_json/dump.md
|
|
- 'emplace': api/basic_json/emplace.md
|
|
- 'emplace_back': api/basic_json/emplace_back.md
|
|
- 'empty': api/basic_json/empty.md
|
|
- 'end': api/basic_json/end.md
|
|
- 'end_pos': api/basic_json/end_pos.md
|
|
- 'erase': api/basic_json/erase.md
|
|
- 'error_handler_t': api/basic_json/error_handler_t.md
|
|
- 'exception': api/basic_json/exception.md
|
|
- 'find': api/basic_json/find.md
|
|
- 'flatten': api/basic_json/flatten.md
|
|
- 'format_as': api/basic_json/format_as.md
|
|
- 'from_bjdata': api/basic_json/from_bjdata.md
|
|
- 'from_bon8': api/basic_json/from_bon8.md
|
|
- 'from_bson': api/basic_json/from_bson.md
|
|
- 'from_cbor': api/basic_json/from_cbor.md
|
|
- 'from_msgpack': api/basic_json/from_msgpack.md
|
|
- 'from_ubjson': api/basic_json/from_ubjson.md
|
|
- 'front': api/basic_json/front.md
|
|
- 'get': api/basic_json/get.md
|
|
- 'get_allocator': api/basic_json/get_allocator.md
|
|
- 'get_binary': api/basic_json/get_binary.md
|
|
- 'get_ptr': api/basic_json/get_ptr.md
|
|
- 'get_ref': api/basic_json/get_ref.md
|
|
- 'get_to': api/basic_json/get_to.md
|
|
- 'std::formatter<basic_json>': api/basic_json/std_formatter.md
|
|
- 'std::hash<basic_json>': api/basic_json/std_hash.md
|
|
- 'input_format_t': api/basic_json/input_format_t.md
|
|
- 'insert': api/basic_json/insert.md
|
|
- 'invalid_iterator': api/basic_json/invalid_iterator.md
|
|
- 'is_array': api/basic_json/is_array.md
|
|
- 'is_binary': api/basic_json/is_binary.md
|
|
- 'is_boolean': api/basic_json/is_boolean.md
|
|
- 'is_discarded': api/basic_json/is_discarded.md
|
|
- 'is_null': api/basic_json/is_null.md
|
|
- 'is_number': api/basic_json/is_number.md
|
|
- 'is_number_float': api/basic_json/is_number_float.md
|
|
- 'is_number_integer': api/basic_json/is_number_integer.md
|
|
- 'is_number_unsigned': api/basic_json/is_number_unsigned.md
|
|
- 'is_object': api/basic_json/is_object.md
|
|
- 'is_primitive': api/basic_json/is_primitive.md
|
|
- 'is_string': api/basic_json/is_string.md
|
|
- 'is_structured': api/basic_json/is_structured.md
|
|
- 'items': api/basic_json/items.md
|
|
- 'json_base_class_t': api/basic_json/json_base_class_t.md
|
|
- 'json_serializer': api/basic_json/json_serializer.md
|
|
- 'max_size': api/basic_json/max_size.md
|
|
- 'meta': api/basic_json/meta.md
|
|
- 'merge_diff': api/basic_json/merge_diff.md
|
|
- 'merge_patch': api/basic_json/merge_patch.md
|
|
- 'number_float_t': api/basic_json/number_float_t.md
|
|
- 'number_integer_t': api/basic_json/number_integer_t.md
|
|
- 'number_unsigned_t': api/basic_json/number_unsigned_t.md
|
|
- 'object': api/basic_json/object.md
|
|
- 'object_comparator_t': api/basic_json/object_comparator_t.md
|
|
- 'object_t': api/basic_json/object_t.md
|
|
- 'operator ValueType': api/basic_json/operator_ValueType.md
|
|
- 'operator value_t': api/basic_json/operator_value_t.md
|
|
- 'operator[]': api/basic_json/operator[].md
|
|
- 'operator=': api/basic_json/operator=.md
|
|
- 'operator+=': api/basic_json/operator+=.md
|
|
- 'operator==': api/basic_json/operator_eq.md
|
|
- 'operator!=': api/basic_json/operator_ne.md
|
|
- 'operator<': api/basic_json/operator_lt.md
|
|
- 'operator>': api/basic_json/operator_gt.md
|
|
- 'operator<=': api/basic_json/operator_le.md
|
|
- 'operator>=': api/basic_json/operator_ge.md
|
|
- 'operator<=>': api/basic_json/operator_spaceship.md
|
|
- 'out_of_range': api/basic_json/out_of_range.md
|
|
- 'other_error': api/basic_json/other_error.md
|
|
- 'parse': api/basic_json/parse.md
|
|
- 'parse_error': api/basic_json/parse_error.md
|
|
- 'parse_event_t': api/basic_json/parse_event_t.md
|
|
- 'parser_callback_t': api/basic_json/parser_callback_t.md
|
|
- 'patch': api/basic_json/patch.md
|
|
- 'patch_inplace': api/basic_json/patch_inplace.md
|
|
- 'push_back': api/basic_json/push_back.md
|
|
- 'rbegin': api/basic_json/rbegin.md
|
|
- 'rend': api/basic_json/rend.md
|
|
- 'sax_parse': api/basic_json/sax_parse.md
|
|
- 'size': api/basic_json/size.md
|
|
- 'start_pos': api/basic_json/start_pos.md
|
|
- 'string_t': api/basic_json/string_t.md
|
|
- 'swap': api/basic_json/swap.md
|
|
- 'std::swap<basic_json>': api/basic_json/std_swap.md
|
|
- 'to_bjdata': api/basic_json/to_bjdata.md
|
|
- 'to_bon8': api/basic_json/to_bon8.md
|
|
- 'to_bson': api/basic_json/to_bson.md
|
|
- 'to_cbor': api/basic_json/to_cbor.md
|
|
- 'to_msgpack': api/basic_json/to_msgpack.md
|
|
- 'to_string': api/basic_json/to_string.md
|
|
- 'to_ubjson': api/basic_json/to_ubjson.md
|
|
- 'type': api/basic_json/type.md
|
|
- 'type_error': api/basic_json/type_error.md
|
|
- 'type_name': api/basic_json/type_name.md
|
|
- 'unflatten': api/basic_json/unflatten.md
|
|
- 'update': api/basic_json/update.md
|
|
- 'value': api/basic_json/value.md
|
|
- 'value_t': api/basic_json/value_t.md
|
|
- 'with_t': api/basic_json/with_t.md
|
|
- byte_container_with_subtype:
|
|
- 'Overview': api/byte_container_with_subtype/index.md
|
|
- '(constructor)': api/byte_container_with_subtype/byte_container_with_subtype.md
|
|
- 'clear_subtype': api/byte_container_with_subtype/clear_subtype.md
|
|
- 'has_subtype': api/byte_container_with_subtype/has_subtype.md
|
|
- 'operator==': api/byte_container_with_subtype/operator_eq.md
|
|
- 'operator!=': api/byte_container_with_subtype/operator_ne.md
|
|
- 'set_subtype': api/byte_container_with_subtype/set_subtype.md
|
|
- 'subtype': api/byte_container_with_subtype/subtype.md
|
|
- adl_serializer:
|
|
- 'Overview': api/adl_serializer/index.md
|
|
- 'from_json': api/adl_serializer/from_json.md
|
|
- 'to_json': api/adl_serializer/to_json.md
|
|
- 'json': api/json.md
|
|
- json_pointer:
|
|
- 'Overview': api/json_pointer/index.md
|
|
- '(Constructor)': api/json_pointer/json_pointer.md
|
|
- 'back': api/json_pointer/back.md
|
|
- 'empty': api/json_pointer/empty.md
|
|
- 'front': api/json_pointer/front.md
|
|
- 'operator string_t': api/json_pointer/operator_string_t.md
|
|
- 'operator==': api/json_pointer/operator_eq.md
|
|
- 'operator!=': api/json_pointer/operator_ne.md
|
|
- 'operator<=>': api/json_pointer/operator_spaceship.md
|
|
- 'operator/': api/json_pointer/operator_slash.md
|
|
- 'operator/=': api/json_pointer/operator_slasheq.md
|
|
- 'parent_pointer': api/json_pointer/parent_pointer.md
|
|
- 'pop_back': api/json_pointer/pop_back.md
|
|
- 'pop_front': api/json_pointer/pop_front.md
|
|
- 'push_back': api/json_pointer/push_back.md
|
|
- 'push_front': api/json_pointer/push_front.md
|
|
- 'string_t': api/json_pointer/string_t.md
|
|
- 'to_string': api/json_pointer/to_string.md
|
|
- json_sax:
|
|
- 'Overview': api/json_sax/index.md
|
|
- 'binary': api/json_sax/binary.md
|
|
- 'boolean': api/json_sax/boolean.md
|
|
- 'end_array': api/json_sax/end_array.md
|
|
- 'end_object': api/json_sax/end_object.md
|
|
- 'key': api/json_sax/key.md
|
|
- 'null': api/json_sax/null.md
|
|
- 'number_float': api/json_sax/number_float.md
|
|
- 'number_integer': api/json_sax/number_integer.md
|
|
- 'number_unsigned': api/json_sax/number_unsigned.md
|
|
- 'parse_error': api/json_sax/parse_error.md
|
|
- 'start_array': api/json_sax/start_array.md
|
|
- 'start_object': api/json_sax/start_object.md
|
|
- 'string': api/json_sax/string.md
|
|
- 'operator<<(basic_json), operator<<(json_pointer)': api/operator_ltlt.md
|
|
- 'operator>>(basic_json)': api/operator_gtgt.md
|
|
- 'operator""_json': api/operator_literal_json.md
|
|
- 'operator""_json_pointer': api/operator_literal_json_pointer.md
|
|
- 'ordered_json': api/ordered_json.md
|
|
- 'ordered_map': api/ordered_map.md
|
|
- macros:
|
|
- 'Overview': api/macros/index.md
|
|
- 'JSON_ASSERT': api/macros/json_assert.md
|
|
- 'JSON_BRACE_INIT_COPY_SEMANTICS': api/macros/json_brace_init_copy_semantics.md
|
|
- 'JSON_CATCH_USER, JSON_THROW_USER, JSON_TRY_USER': api/macros/json_throw_user.md
|
|
- 'JSON_DIAGNOSTICS': api/macros/json_diagnostics.md
|
|
- 'JSON_DELETE_DEPRECATED_FUNCTIONS': api/macros/json_delete_deprecated_functions.md
|
|
- 'JSON_DIAGNOSTIC_POSITIONS': api/macros/json_diagnostic_positions.md
|
|
- 'JSON_DISABLE_ENUM_SERIALIZATION': api/macros/json_disable_enum_serialization.md
|
|
- 'JSON_DISABLE_TUPLE_REFERENCE_CONVERSION': api/macros/json_disable_tuple_reference_conversion.md
|
|
- 'JSON_HAS_CPP_11, JSON_HAS_CPP_14, JSON_HAS_CPP_17, JSON_HAS_CPP_20, JSON_HAS_CPP_23, JSON_HAS_CPP_26': api/macros/json_has_cpp_11.md
|
|
- 'JSON_HAS_EXPERIMENTAL_FILESYSTEM, JSON_HAS_FILESYSTEM': api/macros/json_has_filesystem.md
|
|
- 'JSON_HAS_RANGE_VIEW_CONVERSION': api/macros/json_has_range_view_conversion.md
|
|
- 'JSON_HAS_RANGES': api/macros/json_has_ranges.md
|
|
- 'JSON_HAS_STATIC_RTTI': api/macros/json_has_static_rtti.md
|
|
- 'JSON_HAS_STD_FORMAT': api/macros/json_has_std_format.md
|
|
- 'JSON_HAS_THREE_WAY_COMPARISON': api/macros/json_has_three_way_comparison.md
|
|
- 'JSON_NO_AUTOMATIC_UDLS': api/macros/json_no_automatic_udls.md
|
|
- 'JSON_NOEXCEPTION': api/macros/json_noexception.md
|
|
- 'JSON_NO_IO': api/macros/json_no_io.md
|
|
- 'JSON_NO_THREAD_LOCAL': api/macros/json_no_thread_local.md
|
|
- 'JSON_PRECISE_STREAM_POSITION': api/macros/json_precise_stream_position.md
|
|
- 'JSON_SKIP_LIBRARY_VERSION_CHECK': api/macros/json_skip_library_version_check.md
|
|
- 'JSON_SKIP_UNSUPPORTED_COMPILER_CHECK': api/macros/json_skip_unsupported_compiler_check.md
|
|
- 'JSON_STRICT_BINARY_UTF8': api/macros/json_strict_binary_utf8.md
|
|
- 'JSON_STRICT_NUL_HANDLING': api/macros/json_strict_nul_handling.md
|
|
- 'JSON_USE_GLOBAL_UDLS': api/macros/json_use_global_udls.md
|
|
- 'JSON_USE_IMPLICIT_CONVERSIONS': api/macros/json_use_implicit_conversions.md
|
|
- 'JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON': api/macros/json_use_legacy_discarded_value_comparison.md
|
|
- 'JSON_USE_OBJECTS_FOR_ENUM_KEYED_MAPS': api/macros/json_use_objects_for_enum_keyed_maps.md
|
|
- 'JSON_USE_SIMDUTF': api/macros/json_use_simdutf.md
|
|
- 'NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE, NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_WITH_DEFAULT, NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_ONLY_SERIALIZE, NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE, NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_WITH_DEFAULT, NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_ONLY_SERIALIZE': api/macros/nlohmann_define_derived_type.md
|
|
- 'NLOHMANN_DEFINE_TYPE_INTRUSIVE, NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT, NLOHMANN_DEFINE_TYPE_INTRUSIVE_ONLY_SERIALIZE': api/macros/nlohmann_define_type_intrusive.md
|
|
- 'NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE, NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT, NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_ONLY_SERIALIZE': api/macros/nlohmann_define_type_non_intrusive.md
|
|
- 'NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_NAMES, NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT_WITH_NAMES, NLOHMANN_DEFINE_TYPE_INTRUSIVE_ONLY_SERIALIZE_WITH_NAMES, NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_NAMES, NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT_WITH_NAMES, NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_ONLY_SERIALIZE_WITH_NAMES, NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_WITH_NAMES, NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_WITH_DEFAULT_WITH_NAMES, NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_ONLY_SERIALIZE_WITH_NAMES, NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_WITH_NAMES, NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_WITH_DEFAULT_WITH_NAMES, NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_ONLY_SERIALIZE_WITH_NAMES': api/macros/nlohmann_define_type_with_names.md
|
|
- 'NLOHMANN_JSON_NAMESPACE': api/macros/nlohmann_json_namespace.md
|
|
- 'NLOHMANN_JSON_NAMESPACE_BEGIN, NLOHMANN_JSON_NAMESPACE_END': api/macros/nlohmann_json_namespace_begin.md
|
|
- 'NLOHMANN_JSON_NAMESPACE_NO_VERSION': api/macros/nlohmann_json_namespace_no_version.md
|
|
- 'NLOHMANN_JSON_SERIALIZE_ENUM': api/macros/nlohmann_json_serialize_enum.md
|
|
- 'NLOHMANN_JSON_SERIALIZE_ENUM_STRICT': api/macros/nlohmann_json_serialize_enum_strict.md
|
|
- 'NLOHMANN_JSON_VERSION_MAJOR, NLOHMANN_JSON_VERSION_MINOR, NLOHMANN_JSON_VERSION_PATCH': api/macros/nlohmann_json_version_major.md
|
|
- Community:
|
|
- community/index.md
|
|
- community/ecosystem.md
|
|
- "Code of Conduct": community/code_of_conduct.md
|
|
- community/contribution_guidelines.md
|
|
- community/quality_assurance.md
|
|
- community/governance.md
|
|
- community/roadmap.md
|
|
- community/security_policy.md
|
|
- community/assurance_case.md
|
|
|
|
# Extras
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/nlohmann
|
|
- icon: fontawesome/brands/linkedin
|
|
link: https://www.linkedin.com/in/nielslohmann/
|
|
- icon: fontawesome/brands/xing
|
|
link: https://www.xing.com/profile/Niels_Lohmann
|
|
- icon: fontawesome/brands/paypal
|
|
link: https://www.paypal.me/nlohmann
|
|
generator: false
|
|
|
|
# Extensions
|
|
markdown_extensions:
|
|
- abbr
|
|
- admonition
|
|
- attr_list
|
|
- def_list
|
|
- codehilite:
|
|
guess_lang: false
|
|
- toc:
|
|
permalink: true
|
|
- md_in_html
|
|
- pymdownx.betterem:
|
|
smart_enable: all
|
|
- pymdownx.caret
|
|
- pymdownx.critic
|
|
- pymdownx.details
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.magiclink
|
|
- pymdownx.mark
|
|
#- pymdownx.smartsymbols
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.tilde
|
|
- pymdownx.snippets:
|
|
base_path: docs
|
|
check_paths: true
|
|
restrict_base_path: false # needed to allow including files from the .github folder
|
|
auto_append:
|
|
- ../includes/glossary.md
|
|
|
|
# report broken links, anchors, and nav entries as warnings, so that `mkdocs build --strict` (make build) fails
|
|
validation:
|
|
nav:
|
|
omitted_files: warn
|
|
not_found: warn
|
|
absolute_links: warn
|
|
links:
|
|
not_found: warn
|
|
anchors: warn
|
|
absolute_links: warn
|
|
unrecognized_links: warn
|
|
|
|
hooks:
|
|
- hooks/copy_markdown_source.py
|
|
- hooks/unreleased_versions.py
|
|
|
|
plugins:
|
|
- search:
|
|
separator: '[\s\-\.]'
|
|
lang: en
|
|
- minify:
|
|
minify_html: true
|
|
- git-revision-date-localized:
|
|
strict: false # log "has no git logs" for uncommitted pages as info, not as a warning
|
|
- redirects:
|
|
redirect_maps:
|
|
'api/basic_json/operator_gtgt.md': api/operator_gtgt.md
|
|
'api/basic_json/operator_ltlt.md': api/operator_ltlt.md
|
|
'api/basic_json/operator_literal_json.md': api/operator_literal_json.md
|
|
'api/basic_json/operator_literal_json_pointer.md': api/operator_literal_json_pointer.md
|
|
'api/json_pointer/operator_string.md': api/json_pointer/operator_string_t.md
|
|
'home/code_of_conduct.md': community/code_of_conduct.md
|
|
- htmlproofer: # see https://github.com/manuzhang/mkdocs-htmlproofer-plugin
|
|
enabled: !ENV [ENABLED_HTMLPROOFER, False]
|
|
raise_error_after_finish: true # log every broken link, then fail
|
|
skip_downloads: true # check headers only (customers.md links large PDFs)
|
|
raise_error_excludes: # integer status codes, fnmatch patterns
|
|
403: ['*'] # bot protection against the plugin's "Bot <uuid>" user agent
|
|
429: ['*'] # rate limiting (hundreds of github.com URLs)
|
|
502: ['*']
|
|
503: ['*']
|
|
504: ['*'] # timeouts are reported as 504
|
|
-1: # connection errors
|
|
- 'https://repology.org/*' # repology.org is suspended since 2026-09
|
|
- 'http://2ak5ape.257.cz/' # customers.md: kept although unreachable
|
|
401: ['https://fossies.org/*'] # answers the plugin's user agent with 401, browsers and curl with 200
|
|
404:
|
|
- 'https://gitlab.b-data.ch/*' # answers the plugin's user agent with 404, browsers with 200
|
|
# customers.md: kept although dead
|
|
- 'https://www.cisco.com/c/dam/en_us/about/doing_business/open_source/docs/CiscoWebexDeskCamera-23-1622100417.pdf'
|
|
- 'https://docs.cyberark.com/Downloads/Legal/Privileged%20Session%20Manager%20for%20SSH%20Third-Party%20Notices.pdf'
|
|
500: ['https://marne.io/licenses'] # customers.md: kept although dead
|
|
ignore_urls:
|
|
- mailto:*
|
|
- privacy:
|
|
# repology.org refuses requests from GitHub Actions runners, which made
|
|
# the privacy plugin abort the whole build when it could not download the
|
|
# package badges (the fetch fails, then reading the missing cache entry
|
|
# raises FileNotFoundError). Readers' browsers are served normally, so
|
|
# leave these badges as external references instead of self-hosting them.
|
|
assets_exclude:
|
|
- repology.org/*
|
|
- llmstxt:
|
|
markdown_description: >
|
|
JSON for Modern C++ is a C++11 header-only library implementing a JSON
|
|
value type with an STL-like API, JSON Pointer/Patch, CBOR/MessagePack/
|
|
BSON/UBJSON/BJData/BON8 binary format support, and a SAX-style parser interface.
|
|
sections:
|
|
Home:
|
|
- index.md
|
|
- home/*.md
|
|
Features:
|
|
- features/*.md
|
|
- features/binary_formats/*.md
|
|
- features/element_access/*.md
|
|
- features/parsing/*.md
|
|
- features/types/*.md
|
|
Integration:
|
|
- integration/*.md
|
|
API Documentation:
|
|
- api/*.md
|
|
- api/basic_json/*.md
|
|
- api/adl_serializer/*.md
|
|
- api/byte_container_with_subtype/*.md
|
|
- api/json_pointer/*.md
|
|
- api/json_sax/*.md
|
|
- api/macros/*.md
|
|
Community:
|
|
- community/*.md
|
|
|
|
extra_css:
|
|
- css/custom.css
|