Skip to content

WebAuthn Framework, and what its pages taught the conversion - #7

Merged
Spomky merged 4 commits into
mainfrom
tools/webauthn
Oct 25, 2026
Merged

Spomky merged 4 commits into
mainfrom
tools/webauthn

Conversation

@Spomky

@Spomky Spomky commented Oct 25, 2026

Copy link
Copy Markdown
Member
  • tools/gitbook2material.py: the code blocks GitBook exported as HTML (<pre class="language-x" data-title data-line-numbers>) become fences with title, linenums and hl_lines for the lines whose text is in bold; a one-line <figure> becomes <figure markdown="span"> with a Markdown image, whose path MkDocs rewrites (it never rewrites the src of an HTML image); the image paths GitBook writes between angle brackets because they hold spaces are converted. Sentence case keeps a capital after an emoji, and lowers the first word in parentheses and after a slash.
  • MIGRATING.md: WebAuthn Framework (5.2: the documentation site, MkDocs on GitHub Pages under webauthn-doc.spomky-labs.com web-auth/doc#61 to #63), branches converted one by one when they do not contain each other, the new rules of the table, two traps.

mkdocs build --strict passes.

The organization of a repository must verify the domain before Pages accepts it, since Spomky-Labs has
verified spomky-labs.com; and the pull requests of several versions are merged one by one, as a newer run
of the publication cancels the one waiting.
tools/gitbook2material.py converts the code blocks GitBook exported as HTML into fences with their
highlighted lines, the figures into figures of Material whose image path MkDocs rewrites, and the image
paths GitBook writes between angle brackets; its titles keep a capital after an emoji and lose it after a
parenthesis or a slash.

MIGRATING.md records the state of WebAuthn Framework, the branches converted one by one, the new rules,
and two traps: the links GitBook let rot, and the pages of the root missing from the latest version.
@Spomky

Spomky commented Oct 25, 2026

Copy link
Copy Markdown
Member Author

Rebased on #6 (JWT Framework is migrated), which touched the same lines of MIGRATING.md: merging this pull request merges #6 too.

…conversion

tools/gitbook2material.py converts a figure whose picture has a dark source into two images, one per
colour scheme; tables written on several lines; image names GitBook escaped in HTML; marks coloured with
a variable of GitBook; and it no longer reports the figures it wrote itself when it runs again. A first
word keeps its capital before a slash, and loses the capitals after it.

MIGRATING.md records WebAuthn Framework as migrated, PWA Bundle in pull requests, the new rules and three
traps: links fixed branch by branch, file names that need git archive, and a branch switch after an
uncommitted merge.
@Spomky

Spomky commented Oct 25, 2026

Copy link
Copy Markdown
Member Author

One more commit: WebAuthn Framework is live (the 586 addresses of the GitBook sitemaps checked on webauthn-doc.spomky-labs.com), PWA Bundle is in pull requests (Spomky-Labs/phpwa-doc#19 to #21), and the conversion script learned the figures with a dark picture, the tables on several lines, the image names escaped in HTML and the marks coloured with a variable. Merging this pull request still merges #6.

… latest

Every documentation is on GitHub Pages; what is left is the GitBook spaces. A branch left from GitBook
sorted after the newest published version and took latest from it: pages.yml keeps only the branches
that hold a mkdocs.yml.
@Spomky

Spomky commented Oct 25, 2026

Copy link
Copy Markdown
Member Author

One more commit: PWA Bundle is live (the 397 addresses checked on pwa.spomky-labs.com), and the trap of a branch left from GitBook taking latest is recorded.

@Spomky
Spomky merged commit 79cf0e5 into main Oct 25, 2026
1 check passed
@Spomky
Spomky deleted the tools/webauthn branch October 25, 2026 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant