Upgrade gb-asm-tutorial to use mdbook 0.5#172
Draft
mtthgn wants to merge 1 commit intogbdev:masterfrom
Draft
Conversation
This commit updates the various unpublished crates in the repo to be set up according to the new requirements imposed by mdbook 0.5. In addition, it updates the build and deploy workflow to account for these changes as well. As part of this update, the theme/index.hbs had to be updated to work with some syntax changes made for mdbook 0.5. The style looked off in my browser, so I would appreciate some double checking on this front.
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
1 participant
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.
This PR makes a number of changes, all necessary to address breaking changes introduced in mdBook 0.5:
preprocandi18n-helperscrates now depend on mdbook-preprocessor. As part of 0.5 the mdbook crate was broken down into components.PreProcessortrait slightly changed. Thesupports_renderfunction now returns aResult<bool>instead of merely abool: Addoptionalfield for preprocessors rust-lang/mdBook#2797get_preprocessorwas removed, so I had to usegetinstead: Remove toml as a public dependency rust-lang/mdBook#2773renderercrate now depend onmdbook-rendererandmdbook-html. This one is mostly just updatingusenames.{{#previous}}and{{#next}}handlebars statements to the new syntax: Replace navigation helpers with objects rust-lang/mdBook#2794As part of this update, the theme/index.hbs had to be updated to work with some syntax changes made for mdbook 0.5. The style looked pretty off in my browser (no header nav, sidebar doesn't adjust width, content alignment at certain breakpoints is off), so I would appreciate someone double checking on this front. I'm not sure if this is akin to how pandocs need to be served differently than
mdbook serve, or if something actually broke. Looking at the currently deployed docs, the reason for a custom theme is not immediately apparent to me.Closes #134