Bump zensical to 0.0.60 - #306
Merged
Merged
Conversation
0.0.59 fixed navigation title precedence (zensical/zensical#906): a page's title now comes from its nav label and falls back to the H1, the way MkDocs and Material have always done it. Nothing here sets a title in front matter, so every page takes the label written in mkdocs.yml / mkdocs.ja.yml, and the four slots that render a title move with it -- <title>, og:title, twitter:title and the header topic that appears on scroll -- along with the path breadcrumb in the search index. The nav itself, the headings, the body, the anchors and the URLs do not move. Checked by building both locales with 0.0.58 and again with 0.0.60 and comparing, rather than by reading the release notes: 19 pages per locale with 16 of them differing in those four slots, and the home page in its header topic alone; search.json and ja/search.json keeping their 160 items, locations, text and segmentation config, with only the path breadcrumb following the new title; sitemap.xml, ja/sitemap.xml and objects.inv identical byte for byte; both locales still building --strict with no new warnings. Wheels, dependencies and requires-python are unchanged from 0.0.58. The header comments in docs/requirements.txt went with the bump. What they described -- the migration off MkDocs + Material, and the plugins that replaced mkdocs-static-i18n and mkdocs-callouts -- is finished history, and the one live rule in them, that a bump here is a bump in every repo sharing this pin, is in SpriteStudio-Docs' AGENTS.md under "Pinned toolchain".
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Zensical 0.0.59 fixed navigation title precedence (zensical/zensical#906); 0.0.60 updates the bundled UI to 0.0.28, adds
table-readersupport and fixes template inclusion on Windows extended-length paths. Only the first of those reaches this site — and it reaches almost every page, so the version was checked by building both locales and diffing, not by reading the release notes.Same change as cri-middleware/SpriteStudio-Docs#56, going into every repo that shares this pin.
What the title fix changes
A page's title now comes from its
navlabel and falls back to the H1. That is what MkDocs and Material have always done; 0.0.58 preferred the H1, which is the bug #906 fixed. Nothing underdocs/sets atitle:in front matter, so every page here takes the label written inmkdocs.yml/mkdocs.ja.yml:setup/installworkflow/usage_scriptingworkflow/animation_playerFour slots move with the title —
<title>,og:title,twitter:title, and the header topic that appears on scroll — plus thepathbreadcrumb in the search index. The nav itself, the H1, the body, the heading anchors and the URLs are untouched.Verified
Built en and ja with 0.0.58 and again with 0.0.60, and compared:
&is now written as a bare&instead of&. That is Zensical's own escaping of the title it renders; it displays identically, and no label here contains<or anything an HTML parser would read as an entity.search.jsonandja/search.json: 160 items on both sides, samelocation, sametext, same segmentationconfig. Only thepathbreadcrumb follows the new title. The Japanese index is the fragile one — it is segmented into words — and it is intact.sitemap.xml,ja/sitemap.xmlandobjects.invbyte-identical.--strict, no new warnings.<title>collisions: 19 distinct titles per locale, before and after.requires-pythonunchanged from 0.0.58. The 32-bit wheels 0.0.58 dropped have not come back, which stays irrelevant onubuntu-latestand macOS.CI cannot confirm any of this: Actions runs in this org still fail before the job starts, so the local build is the only gate — as it was for 0.0.58.
What changed
docs/requirements.txt— the pin, now the whole file. The header comments were about the migration off MkDocs + Material and about the plugins that replacedmkdocs-static-i18nandmkdocs-callouts, which is finished history. The one live rule in them — a bump here is a bump in every repo that shares this pin — lives in SpriteStudio-Docs'AGENTS.mdunder "Pinned toolchain", which also names the repos.Why bump when the output moves
Because the move is Zensical catching up with MkDocs, not drifting from it, and because the pin is worth keeping current until Zensical grows native
mkdocs-static-i18nsupport (zensical/backlog#1) — the one release that would let these repos build both locales from a single config instead of two. Nothing has shipped from these sites that a changed<title>would invalidate.