Repository navigation
4.3: the documentation site, merged forward from 4.2 - #58
Merged
Merged
Conversation
MkDocs reads its pages from a directory of their own, and GitBook follows them there through .gitbook.yaml.
The hints become admonitions, the code blocks carry their title on the fence, the tables GitBook wrote in HTML become Markdown tables, and the coloured marks lose their colour: the Slabs guidelines never let a colour carry a meaning, so a red mark keeps its insistence in bold. Converted by tools/gitbook2material.py of Spomky-Labs/docs, then read page by page.
The Slabs guidelines set every title on the web in sentence case. The names keep their capitals: JWT Framework, Symfony, Symfony Flex, the acronyms (JWS, JWE, JWK, JWA, PHAR, PSR-20) and the class names.
GitBook resolved a link to a directory to the README.md it holds; MkDocs wants the page itself.
The pages are built by MkDocs and Material for MkDocs, one version per branch through mike, on GitHub Pages under web-token.spomky-labs.com, in the look of the Slabs brand guidelines v2.0, with the project mark of JWT Framework in the header. The toolchain, the workflows, the stylesheets and the theme partials come from the documentation of Web Push Framework, recorded in Spomky-Labs/docs. Only the versions 4.0 to 4.3 are published. site-root/404.html sends the GitBook variants v4.0, v4.1 and v4.3 to their version, the root and every older variant (v3.3-1, v3.0-1, 3.2, 2.x, 1.x) to the same page of the latest version. docs/SUMMARY.md and .gitbook.yaml keep the GitBook space working until the domain moves.
The pages of 4.1 move to docs/ and are converted the way those of 4.0 were, by tools/gitbook2material.py of Spomky-Labs/docs: admonitions, titled fences, Markdown tables, marks without colour, titles in sentence case. docs/ is exactly the conversion of the GitBook content of 4.1; the navigation of mkdocs.yml follows its SUMMARY.md, and edit_uri points at 4.1.
The pages of 4.2 move to docs/ and are converted the way those of the previous version were, by tools/gitbook2material.py of Spomky-Labs/docs. docs/ is exactly the conversion of the GitBook content of 4.2; the navigation of mkdocs.yml follows its SUMMARY.md, and edit_uri points at 4.2.
The pages of 4.3 move to docs/ and are converted the way those of the previous version were, by tools/gitbook2material.py of Spomky-Labs/docs. docs/ is exactly the conversion of the GitBook content of 4.3; the navigation of mkdocs.yml follows its SUMMARY.md, and edit_uri points at 4.3.
…tBook keep leading to them GitBook published them under console-commands/ and benchmarks/; the directories are console-command/ and benchmark/. The root of the GitBook site goes to the latest version, so 4.3 carries the redirects.
…dresses that land somewhere The contents of the page, on the right, take the 288 px of the side band, as the navigation does on the left; the reading column keeps its 864 px. An address of the former GitBook site whose page does not exist in the version it is sent to now lands on the home page of that version instead of on "page not found": the variants that are not published (1.x to 3.3) had another tree of pages.
* chore/mkdocs-4.0: style: the contents of the page as wide as the navigation, and old addresses that land somewhere
…tBook keep leading to them GitBook published them under console-commands/ and benchmarks/ from 4.1 on; the directories are console-command/ and benchmark/.
* chore/mkdocs-4.1: chore: the addresses of the console commands and the benchmarks on GitBook keep leading to them style: the contents of the page as wide as the navigation, and old addresses that land somewhere
* chore/mkdocs-4.2: chore: the addresses of the console commands and the benchmarks on GitBook keep leading to them style: the contents of the page as wide as the navigation, and old addresses that land somewhere # Conflicts: # mkdocs.yml
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.
Merges the documentation site of 4.2 into 4.3, then converts the pages of 4.3 the same way. Merge after the pull request of 4.2. The full description is in the pull request of 4.0.
docs/is exactly the conversion of the GitBook content of 4.3, bytools/gitbook2material.pyof Spomky-Labs/docs: converted again from scratch and compared, file by file.mkdocs.ymlfollows theSUMMARY.mdof 4.3, andedit_uripoints at 4.3.mkdocs build --strictpasses. Published together with the other versions and served with the behaviour of GitHub Pages, the 538 addresses of the GitBook sitemaps all land on a page.