amorfo77/json

0 Fork 0

mirror of https://github.com/nlohmann/json.git synced 2026-10-28 16:55:41 +00:00

Files

T

Niels Lohmann a47170346a docs: new design for the documentation site (#5934 )

* docs: new design for the documentation site

Apply the brand to the Material for MkDocs site: Inter and JetBrains Mono
served by the site (upright and real italic), brand colours, blue header band
with the syntax pattern, wordmark in the header, new home page (hero, cards,
animated feature tour), 404 page, polish for tabs, search, footer, focus
rings, tables and code blocks, and theme features (code copy, previous/next
footer, TOC follow, search suggestions).

Draw the number railroad diagram, the parser callback events and the iterator
illustrations as inline SVGs that follow the light and dark scheme. The
generator scripts are in docs/mkdocs/scripts/figures; the feature slideshow
(json-light.svg, json-dark.svg, replacing json.gif on the home page) is built
by docs/mkdocs/scripts/slideshow. Decision nodes in five flowcharts become
hexagons, which need far less room.

Signed-off-by: Niels Lohmann <mail@nlohmann.me>

* docs: add figures, table captions and a macro chooser

- Figures with numbered captions: SAX stepper, json_view layout and edit
  stepper, exception map, JSON pointer and patch walkers, QA pipeline,
  scaling and binary size charts, roadmap lanes, release timeline,
  integration decision tree and namespace builder
- Table captions (nj-table-caption) on 9 pages
- Compile times: modules and PCH charts, filesystem section, re-measured
  Figure 1, links between features/modules.md and compile_times.md
- Interactive macro chooser for features/arbitrary_types.md
- Link check: exclude URLs that answer the plugin with 400/401/419 or are
  dead (customers.md)

Signed-off-by: Niels Lohmann <mail@nlohmann.me>

* docs: macro chooser generates adl_serializer for non-default-constructible types

Signed-off-by: Niels Lohmann <mail@nlohmann.me>

* docs: cross-link concept pages and API pages in See also sections

Add See also links in both directions between the concept pages (features,
home, integration) and the API pages, write API links in code font, give every
entry a comment after a dash, and show the callback event figure on the parser
callbacks page.

Signed-off-by: Niels Lohmann <mail@nlohmann.me>

* docs: address review comments on the new design

- Home: add a "Latest release" button
- Sponsors: update the list and group it by tier
- Features: list all feature pages on the index page
- Releases: add highlights per release, link the 4.0 roadmap, add the first commit to the timeline
- Exceptions: prefix all example messages with the exception name
- API: no code font for format names in the See also links of the to_/from_ pages
- Merge Patch: show the document before, the patch, and the result
- Replace "--" with typographic dashes, mark external links with an icon, center Mermaid diagrams

Signed-off-by: Niels Lohmann <mail@nlohmann.me>

---------

Signed-off-by: Niels Lohmann <mail@nlohmann.me>

2026-10-27 07:41:42 +01:00

5.4 KiB

Raw Blame History

Binary Formats

Though JSON is a ubiquitous data format, it is not a very compact format suitable for data exchange, for instance, over a network. Hence, the library supports

BJData (Binary JData),
BON8 (Binary Object Notation 8),
BSON (Binary JSON),
CBOR (Concise Binary Object Representation),
MessagePack, and
UBJSON (Universal Binary JSON)

to efficiently encode JSON values to byte vectors and to decode such vectors.

Comparison

Completeness

Format	Serialization	Deserialization
BJData	complete	incomplete: no column-major ND-arrays, no Draft 4 SoA/extension types
BON8	incomplete: no unsigned integers above int64	complete
BSON	incomplete: top-level value must be an object	incomplete, but all JSON types are supported
CBOR	complete	incomplete, but all JSON types are supported
MessagePack	complete	incomplete, but all JSON types are supported
UBJSON	complete	complete

Binary values

Format	Binary values	Binary subtypes
BJData	supported (Draft 3 only)	not supported
BON8	not supported	not supported
BSON	supported	supported
CBOR	supported	supported
MessagePack	supported	supported
UBJSON	not supported	not supported

See binary values for more information.

Sizes

Format	canada.json	twitter.json	citm_catalog.json	jeopardy.json
BJData	53.2 %	91.1 %	78.1 %	96.6 %
BJData (size)	58.6 %	92.1 %	86.7 %	97.4 %
BJData (size+type)	58.6 %	92.1 %	86.5 %	97.4 %
BON8	50.5 %	83.8 %	63.5 %	87.5 %
BSON	85.8 %	95.2 %	95.8 %	106.7 %
CBOR	50.5 %	86.3 %	68.4 %	88.0 %
MessagePack	50.5 %	86.0 %	68.5 %	87.9 %
UBJSON	53.2 %	91.3 %	78.2 %	96.6 %
UBJSON (size)	58.6 %	92.3 %	86.8 %	97.4 %
UBJSON (size+type)	55.9 %	92.3 %	85.0 %	95.0 %

Size of each test file in each format, in percent of the minified JSON value; the smallest size per file is printed in bold. The (size) and (size+type) rows are written with the `use_size` and `use_type` options of [`to_bjdata`](../../api/basic_json/to_bjdata.md) and [`to_ubjson`](../../api/basic_json/to_ubjson.md).

--8<-- "images/binary_sizes_canada.svg"

--8<-- "images/binary_sizes_twitter.svg"

--8<-- "images/binary_sizes_citm_catalog.svg"

--8<-- "images/binary_sizes_jeopardy.svg"

The table above as charts: size per base format relative to minified JSON (vertical line at 100 %); the smallest format per file is drawn in a stronger colour than the others. The size and size+type variants of BJData and UBJSON are omitted here; see the table.

5.4 KiB Raw Blame History