mkdocs.yml 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362
  1. # Project information
  2. site_name: JSON for Modern C++
  3. site_author: Niels Lohmann
  4. site_url: https://json.nlohmann.me/
  5. # Repository
  6. repo_name: nlohmann/json
  7. repo_url: https://github.com/nlohmann/json
  8. edit_uri: edit/develop/docs/mkdocs/docs
  9. # Copyright
  10. copyright: Copyright © 2013 - 2022 Niels Lohmann
  11. # Configuration
  12. theme:
  13. name: material
  14. language: en
  15. palette:
  16. - media: '(prefers-color-scheme: light)'
  17. scheme: default
  18. primary: indigo
  19. accent: indigo
  20. toggle:
  21. icon: material/brightness-7
  22. name: Switch to dark mode
  23. - media: '(prefers-color-scheme: dark)'
  24. scheme: slate
  25. primary: indigo
  26. accent: indigo
  27. toggle:
  28. icon: material/brightness-4
  29. name: Switch to light mode
  30. font:
  31. text: Roboto
  32. code: JetBrains Mono
  33. features:
  34. - navigation.instant
  35. - navigation.tracking
  36. - navigation.tabs
  37. - navigation.indexes
  38. - navigation.top
  39. nav:
  40. - Home:
  41. - index.md
  42. - home/license.md
  43. - "Code of Conduct": home/code_of_conduct.md
  44. - "FAQ": home/faq.md
  45. - home/exceptions.md
  46. - home/releases.md
  47. - home/design_goals.md
  48. - home/sponsors.md
  49. - Features:
  50. - features/arbitrary_types.md
  51. - Binary Formats:
  52. - features/binary_formats/index.md
  53. - features/binary_formats/bjdata.md
  54. - features/binary_formats/bson.md
  55. - features/binary_formats/cbor.md
  56. - features/binary_formats/messagepack.md
  57. - features/binary_formats/ubjson.md
  58. - features/binary_values.md
  59. - features/comments.md
  60. - Element Access:
  61. - features/element_access/index.md
  62. - features/element_access/unchecked_access.md
  63. - features/element_access/checked_access.md
  64. - features/element_access/default_value.md
  65. - features/iterators.md
  66. - features/json_pointer.md
  67. - features/json_patch.md
  68. - features/merge_patch.md
  69. - 'nlohmann Namespace': features/namespace.md
  70. - features/object_order.md
  71. - Parsing:
  72. - features/parsing/index.md
  73. - features/parsing/json_lines.md
  74. - features/parsing/parse_exceptions.md
  75. - features/parsing/parser_callbacks.md
  76. - features/parsing/sax_interface.md
  77. - features/assertions.md
  78. - features/enum_conversion.md
  79. - features/macros.md
  80. - Types:
  81. - features/types/index.md
  82. - features/types/number_handling.md
  83. - Integration:
  84. - integration/index.md
  85. - integration/cmake.md
  86. - integration/package_managers.md
  87. - integration/pkg-config.md
  88. - API Documentation:
  89. - basic_json:
  90. - 'Overview': api/basic_json/index.md
  91. - '(Constructor)': api/basic_json/basic_json.md
  92. - '(Destructor)': api/basic_json/~basic_json.md
  93. - 'accept': api/basic_json/accept.md
  94. - 'array': api/basic_json/array.md
  95. - 'array_t': api/basic_json/array_t.md
  96. - 'at': api/basic_json/at.md
  97. - 'back': api/basic_json/back.md
  98. - 'begin': api/basic_json/begin.md
  99. - 'binary': api/basic_json/binary.md
  100. - 'binary_t': api/basic_json/binary_t.md
  101. - 'boolean_t': api/basic_json/boolean_t.md
  102. - 'cbegin': api/basic_json/cbegin.md
  103. - 'cbor_tag_handler_t': api/basic_json/cbor_tag_handler_t.md
  104. - 'cend': api/basic_json/cend.md
  105. - 'clear': api/basic_json/clear.md
  106. - 'contains': api/basic_json/contains.md
  107. - 'count': api/basic_json/count.md
  108. - 'crbegin': api/basic_json/crbegin.md
  109. - 'crend': api/basic_json/crend.md
  110. - 'default_object_comparator_t': api/basic_json/default_object_comparator_t.md
  111. - 'diff': api/basic_json/diff.md
  112. - 'dump': api/basic_json/dump.md
  113. - 'emplace': api/basic_json/emplace.md
  114. - 'emplace_back': api/basic_json/emplace_back.md
  115. - 'empty': api/basic_json/empty.md
  116. - 'end': api/basic_json/end.md
  117. - 'erase': api/basic_json/erase.md
  118. - 'error_handler_t': api/basic_json/error_handler_t.md
  119. - 'exception': api/basic_json/exception.md
  120. - 'find': api/basic_json/find.md
  121. - 'flatten': api/basic_json/flatten.md
  122. - 'from_bjdata': api/basic_json/from_bjdata.md
  123. - 'from_bson': api/basic_json/from_bson.md
  124. - 'from_cbor': api/basic_json/from_cbor.md
  125. - 'from_msgpack': api/basic_json/from_msgpack.md
  126. - 'from_ubjson': api/basic_json/from_ubjson.md
  127. - 'front': api/basic_json/front.md
  128. - 'get': api/basic_json/get.md
  129. - 'get_allocator': api/basic_json/get_allocator.md
  130. - 'get_binary': api/basic_json/get_binary.md
  131. - 'get_ptr': api/basic_json/get_ptr.md
  132. - 'get_ref': api/basic_json/get_ref.md
  133. - 'get_to': api/basic_json/get_to.md
  134. - 'std::hash<basic_json>': api/basic_json/std_hash.md
  135. - 'input_format_t': api/basic_json/input_format_t.md
  136. - 'insert': api/basic_json/insert.md
  137. - 'invalid_iterator': api/basic_json/invalid_iterator.md
  138. - 'is_array': api/basic_json/is_array.md
  139. - 'is_binary': api/basic_json/is_binary.md
  140. - 'is_boolean': api/basic_json/is_boolean.md
  141. - 'is_discarded': api/basic_json/is_discarded.md
  142. - 'is_null': api/basic_json/is_null.md
  143. - 'is_number': api/basic_json/is_number.md
  144. - 'is_number_float': api/basic_json/is_number_float.md
  145. - 'is_number_integer': api/basic_json/is_number_integer.md
  146. - 'is_number_unsigned': api/basic_json/is_number_unsigned.md
  147. - 'is_object': api/basic_json/is_object.md
  148. - 'is_primitive': api/basic_json/is_primitive.md
  149. - 'is_string': api/basic_json/is_string.md
  150. - 'is_structured': api/basic_json/is_structured.md
  151. - 'items': api/basic_json/items.md
  152. - 'json_base_class_t': api/basic_json/json_base_class_t.md
  153. - 'json_serializer': api/basic_json/json_serializer.md
  154. - 'max_size': api/basic_json/max_size.md
  155. - 'meta': api/basic_json/meta.md
  156. - 'merge_patch': api/basic_json/merge_patch.md
  157. - 'number_float_t': api/basic_json/number_float_t.md
  158. - 'number_integer_t': api/basic_json/number_integer_t.md
  159. - 'number_unsigned_t': api/basic_json/number_unsigned_t.md
  160. - 'object': api/basic_json/object.md
  161. - 'object_comparator_t': api/basic_json/object_comparator_t.md
  162. - 'object_t': api/basic_json/object_t.md
  163. - 'operator ValueType': api/basic_json/operator_ValueType.md
  164. - 'operator value_t': api/basic_json/operator_value_t.md
  165. - 'operator[]': api/basic_json/operator[].md
  166. - 'operator=': api/basic_json/operator=.md
  167. - 'operator+=': api/basic_json/operator+=.md
  168. - 'operator==': api/basic_json/operator_eq.md
  169. - 'operator!=': api/basic_json/operator_ne.md
  170. - 'operator<': api/basic_json/operator_lt.md
  171. - 'operator>': api/basic_json/operator_gt.md
  172. - 'operator<=': api/basic_json/operator_le.md
  173. - 'operator>=': api/basic_json/operator_ge.md
  174. - 'operator<=>': api/basic_json/operator_spaceship.md
  175. - 'out_of_range': api/basic_json/out_of_range.md
  176. - 'other_error': api/basic_json/other_error.md
  177. - 'parse': api/basic_json/parse.md
  178. - 'parse_error': api/basic_json/parse_error.md
  179. - 'parse_event_t': api/basic_json/parse_event_t.md
  180. - 'parser_callback_t': api/basic_json/parser_callback_t.md
  181. - 'patch': api/basic_json/patch.md
  182. - 'patch_inplace': api/basic_json/patch_inplace.md
  183. - 'push_back': api/basic_json/push_back.md
  184. - 'rbegin': api/basic_json/rbegin.md
  185. - 'rend': api/basic_json/rend.md
  186. - 'sax_parse': api/basic_json/sax_parse.md
  187. - 'size': api/basic_json/size.md
  188. - 'string_t': api/basic_json/string_t.md
  189. - 'swap': api/basic_json/swap.md
  190. - 'std::swap&lt;basic_json&gt;': api/basic_json/std_swap.md
  191. - 'to_bjdata': api/basic_json/to_bjdata.md
  192. - 'to_bson': api/basic_json/to_bson.md
  193. - 'to_cbor': api/basic_json/to_cbor.md
  194. - 'to_msgpack': api/basic_json/to_msgpack.md
  195. - 'to_string': api/basic_json/to_string.md
  196. - 'to_ubjson': api/basic_json/to_ubjson.md
  197. - 'type': api/basic_json/type.md
  198. - 'type_error': api/basic_json/type_error.md
  199. - 'type_name': api/basic_json/type_name.md
  200. - 'unflatten': api/basic_json/unflatten.md
  201. - 'update': api/basic_json/update.md
  202. - 'value': api/basic_json/value.md
  203. - 'value_t': api/basic_json/value_t.md
  204. - byte_container_with_subtype:
  205. - 'Overview': api/byte_container_with_subtype/index.md
  206. - '(constructor)': api/byte_container_with_subtype/byte_container_with_subtype.md
  207. - 'clear_subtype': api/byte_container_with_subtype/clear_subtype.md
  208. - 'has_subtype': api/byte_container_with_subtype/has_subtype.md
  209. - 'set_subtype': api/byte_container_with_subtype/set_subtype.md
  210. - 'subtype': api/byte_container_with_subtype/subtype.md
  211. - adl_serializer:
  212. - 'Overview': api/adl_serializer/index.md
  213. - 'from_json': api/adl_serializer/from_json.md
  214. - 'to_json': api/adl_serializer/to_json.md
  215. - 'json': api/json.md
  216. - json_pointer:
  217. - 'Overview': api/json_pointer/index.md
  218. - '(Constructor)': api/json_pointer/json_pointer.md
  219. - 'back': api/json_pointer/back.md
  220. - 'empty': api/json_pointer/empty.md
  221. - 'operator string_t': api/json_pointer/operator_string_t.md
  222. - 'operator==': api/json_pointer/operator_eq.md
  223. - 'operator!=': api/json_pointer/operator_ne.md
  224. - 'operator/': api/json_pointer/operator_slash.md
  225. - 'operator/=': api/json_pointer/operator_slasheq.md
  226. - 'parent_pointer': api/json_pointer/parent_pointer.md
  227. - 'pop_back': api/json_pointer/pop_back.md
  228. - 'push_back': api/json_pointer/push_back.md
  229. - 'string_t': api/json_pointer/string_t.md
  230. - 'to_string': api/json_pointer/to_string.md
  231. - json_sax:
  232. - 'Overview': api/json_sax/index.md
  233. - 'binary': api/json_sax/binary.md
  234. - 'boolean': api/json_sax/boolean.md
  235. - 'end_array': api/json_sax/end_array.md
  236. - 'end_object': api/json_sax/end_object.md
  237. - 'key': api/json_sax/key.md
  238. - 'null': api/json_sax/null.md
  239. - 'number_float': api/json_sax/number_float.md
  240. - 'number_integer': api/json_sax/number_integer.md
  241. - 'number_unsigned': api/json_sax/number_unsigned.md
  242. - 'parse_error': api/json_sax/parse_error.md
  243. - 'start_array': api/json_sax/start_array.md
  244. - 'start_object': api/json_sax/start_object.md
  245. - 'string': api/json_sax/string.md
  246. - 'operator<<(basic_json)': api/operator_ltlt.md
  247. - 'operator<<(json_pointer)': api/operator_ltlt.md
  248. - 'operator>>(basic_json)': api/operator_gtgt.md
  249. - 'operator""_json': api/operator_literal_json.md
  250. - 'operator""_json_pointer': api/operator_literal_json_pointer.md
  251. - 'ordered_json': api/ordered_json.md
  252. - 'ordered_map': api/ordered_map.md
  253. - macros:
  254. - 'Overview': api/macros/index.md
  255. - 'JSON_ASSERT': api/macros/json_assert.md
  256. - 'JSON_CATCH_USER': api/macros/json_throw_user.md
  257. - 'JSON_DIAGNOSTICS': api/macros/json_diagnostics.md
  258. - 'JSON_DISABLE_ENUM_SERIALIZATION': api/macros/json_disable_enum_serialization.md
  259. - 'JSON_HAS_CPP_11': api/macros/json_has_cpp_11.md
  260. - 'JSON_HAS_CPP_14': api/macros/json_has_cpp_11.md
  261. - 'JSON_HAS_CPP_17': api/macros/json_has_cpp_11.md
  262. - 'JSON_HAS_CPP_20': api/macros/json_has_cpp_11.md
  263. - 'JSON_HAS_EXPERIMENTAL_FILESYSTEM': api/macros/json_has_filesystem.md
  264. - 'JSON_HAS_FILESYSTEM': api/macros/json_has_filesystem.md
  265. - 'JSON_HAS_RANGES': api/macros/json_has_ranges.md
  266. - 'JSON_HAS_THREE_WAY_COMPARISON': api/macros/json_has_three_way_comparison.md
  267. - 'JSON_NOEXCEPTION': api/macros/json_noexception.md
  268. - 'JSON_NO_IO': api/macros/json_no_io.md
  269. - 'JSON_SKIP_LIBRARY_VERSION_CHECK': api/macros/json_skip_library_version_check.md
  270. - 'JSON_SKIP_UNSUPPORTED_COMPILER_CHECK': api/macros/json_skip_unsupported_compiler_check.md
  271. - 'JSON_THROW_USER': api/macros/json_throw_user.md
  272. - 'JSON_TRY_USER': api/macros/json_throw_user.md
  273. - 'JSON_USE_GLOBAL_UDLS': api/macros/json_use_global_udls.md
  274. - 'JSON_USE_IMPLICIT_CONVERSIONS': api/macros/json_use_implicit_conversions.md
  275. - 'JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON': api/macros/json_use_legacy_discarded_value_comparison.md
  276. - 'NLOHMANN_DEFINE_TYPE_INTRUSIVE': api/macros/nlohmann_define_type_intrusive.md
  277. - 'NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT': api/macros/nlohmann_define_type_intrusive.md
  278. - 'NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE': api/macros/nlohmann_define_type_non_intrusive.md
  279. - 'NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT': api/macros/nlohmann_define_type_non_intrusive.md
  280. - 'NLOHMANN_JSON_NAMESPACE': api/macros/nlohmann_json_namespace.md
  281. - 'NLOHMANN_JSON_NAMESPACE_BEGIN': api/macros/nlohmann_json_namespace_begin.md
  282. - 'NLOHMANN_JSON_NAMESPACE_END': api/macros/nlohmann_json_namespace_begin.md
  283. - 'NLOHMANN_JSON_NAMESPACE_NO_VERSION': api/macros/nlohmann_json_namespace_no_version.md
  284. - 'NLOHMANN_JSON_SERIALIZE_ENUM': api/macros/nlohmann_json_serialize_enum.md
  285. - 'NLOHMANN_JSON_VERSION_MAJOR': api/macros/nlohmann_json_version_major.md
  286. - 'NLOHMANN_JSON_VERSION_MINOR': api/macros/nlohmann_json_version_major.md
  287. - 'NLOHMANN_JSON_VERSION_PATCH': api/macros/nlohmann_json_version_major.md
  288. # Extras
  289. extra:
  290. social:
  291. - icon: fontawesome/brands/github
  292. link: https://github.com/nlohmann
  293. - icon: fontawesome/brands/twitter
  294. link: https://twitter.com/nlohmann
  295. - icon: fontawesome/brands/linkedin
  296. link: https://www.linkedin.com/in/nielslohmann/
  297. - icon: fontawesome/brands/xing
  298. link: https://www.xing.com/profile/Niels_Lohmann
  299. - icon: fontawesome/brands/paypal
  300. link: https://www.paypal.me/nlohmann
  301. generator: false
  302. # Extensions
  303. markdown_extensions:
  304. - abbr
  305. - admonition
  306. - attr_list
  307. - def_list
  308. - codehilite:
  309. guess_lang: false
  310. - toc:
  311. permalink: true
  312. - pymdownx.arithmatex
  313. - pymdownx.betterem:
  314. smart_enable: all
  315. - pymdownx.caret
  316. - pymdownx.critic
  317. - pymdownx.details
  318. - pymdownx.emoji:
  319. emoji_index: !!python/name:materialx.emoji.twemoji
  320. emoji_generator: !!python/name:materialx.emoji.to_svg
  321. - pymdownx.inlinehilite
  322. - pymdownx.magiclink
  323. - pymdownx.mark
  324. #- pymdownx.smartsymbols
  325. - pymdownx.superfences
  326. - pymdownx.tasklist:
  327. custom_checkbox: true
  328. - pymdownx.tabbed
  329. - pymdownx.tilde
  330. - pymdownx.snippets:
  331. base_path: docs
  332. check_paths: true
  333. - plantuml_markdown:
  334. format: svg
  335. plugins:
  336. - search:
  337. separator: '[\s\-\.]'
  338. lang: en
  339. - minify:
  340. minify_html: true
  341. - git-revision-date-localized
  342. - redirects:
  343. redirect_maps:
  344. 'api/basic_json/operator_gtgt.md': api/operator_gtgt.md
  345. 'api/basic_json/operator_ltlt.md': api/operator_ltlt.md
  346. 'api/basic_json/operator_literal_json.md': api/operator_literal_json.md
  347. 'api/basic_json/operator_literal_json_pointer.md': api/operator_literal_json_pointer.md
  348. 'api/json_pointer/operator_string.md': api/json_pointer/operator_string_t.md
  349. extra_css:
  350. - css/custom.css
  351. extra_javascript:
  352. - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML