mirror of
https://github.com/nlohmann/json.git
synced 2026-10-28 08:45:43 +00:00
Niels Lohmann
a47170346a
* 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>
74 lines
2.6 KiB
Makefile
74 lines
2.6 KiB
Makefile
# Rebuild the animated feature slideshow of the home page (docs/images/json-light.svg and json-dark.svg) when
|
|
# slides.md, build.py or the fonts change. Needs uv (build.py declares its dependencies inline, PEP 723), curl,
|
|
# unzip and shasum. Run it from docs/mkdocs/scripts/slideshow.
|
|
#
|
|
# make download missing fonts and build both SVGs
|
|
# make fonts download only the fonts
|
|
# make SECONDS=12 change the time per slide
|
|
# make clean remove the generated SVGs
|
|
# make distclean also remove the downloaded fonts
|
|
|
|
SECONDS ?= 15
|
|
|
|
IMAGES := ../../docs/images
|
|
LIGHT := $(IMAGES)/json-light.svg
|
|
DARK := $(IMAGES)/json-dark.svg
|
|
|
|
RUN := uv run --script build.py
|
|
FONTS := fonts/Inter.ttf fonts/JetBrainsMono.ttf
|
|
DEPS := build.py slides.md $(FONTS)
|
|
|
|
# Pinned sources; the checksums make a changed upstream file fail instead of silently changing the output.
|
|
# Inter: Google Fonts repository at a fixed commit (variable font with opsz and wght axes).
|
|
INTER_URL := https://raw.githubusercontent.com/google/fonts/0b58fb370093f9a9f4ff785d94405710b79de67c/ofl/inter/Inter%5Bopsz%2Cwght%5D.ttf
|
|
# JetBrains Mono: release 2.304 (the variable font in fonts/variable/ of the zip).
|
|
JBM_URL := https://github.com/JetBrains/JetBrainsMono/releases/download/v2.304/JetBrainsMono-2.304.zip
|
|
JBM_ZIP := fonts/JetBrainsMono-2.304.zip
|
|
|
|
SHA256_Inter.ttf := 29160a80ff49ddcab2c97711247e08b1fab27a484a329ce8b813d820dc559031
|
|
SHA256_JetBrainsMono.ttf := 662a196d58f1183bf2d77428b6d5283fe3f45161ab021bea4036bc98e5cac016
|
|
SHA256_JetBrainsMono-2.304.zip := 6f6376c6ed2960ea8a963cd7387ec9d76e3f629125bc33d1fdcd7eb7012f7bbf
|
|
|
|
# Check $@.tmp against its pinned checksum, then move it into place.
|
|
define verify
|
|
echo '$(SHA256_$(notdir $@)) $@.tmp' | shasum -a 256 -c --quiet - || { rm -f $@.tmp; exit 1; }
|
|
mv $@.tmp $@
|
|
endef
|
|
|
|
.PHONY: all fonts clean distclean
|
|
.INTERMEDIATE: $(JBM_ZIP)
|
|
|
|
all: $(LIGHT) $(DARK)
|
|
|
|
fonts: $(FONTS)
|
|
|
|
# fixed colours for the docs: an <img> cannot see Material's theme toggle, so the home page includes both
|
|
# and shows the one that matches
|
|
$(LIGHT): $(DEPS)
|
|
$(RUN) $@.tmp $(SECONDS) light
|
|
mv $@.tmp $@
|
|
|
|
$(DARK): $(DEPS)
|
|
$(RUN) $@.tmp $(SECONDS) dark
|
|
mv $@.tmp $@
|
|
|
|
fonts/Inter.ttf:
|
|
mkdir -p fonts
|
|
curl -fsSL -m 300 -o $@.tmp '$(INTER_URL)'
|
|
$(verify)
|
|
|
|
$(JBM_ZIP):
|
|
mkdir -p fonts
|
|
curl -fsSL -m 300 -o $@.tmp '$(JBM_URL)'
|
|
$(verify)
|
|
|
|
fonts/JetBrainsMono.ttf: | $(JBM_ZIP)
|
|
unzip -p $(JBM_ZIP) 'fonts/variable/JetBrainsMono[[]wght].ttf' > $@.tmp
|
|
$(verify)
|
|
|
|
clean:
|
|
rm -f $(LIGHT) $(DARK) $(IMAGES)/*.svg.tmp
|
|
|
|
distclean: clean
|
|
rm -f $(FONTS) fonts/*.tmp $(JBM_ZIP)
|