-
Notifications
You must be signed in to change notification settings - Fork 3.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update for markdown changes. #1984
Conversation
The reason some of the paragraphs are wrapped weird is because of #199, which I believe will be fixed in the new mdbook, but isn't in the old mdbook :( The one place in chapter 19-01 that this applied to doesn't have that problem anymore with the rewrapping you did, so shrug? Yeah, I think the other places it just looked weird, but it's fine.
It's not really used, but at the same time I don't want to give it up yet either, just in case. It's only used when I'm creating markdown suitable for sending to nostarch, which doesn't happen very much anymore, but it might happen again someday with more major revisions that I don't know about yet, so I'd like to keep it. The link2print and remove_links scripts had some bugs in them that I've kind of been manually fixing but this nudged me to actually fix them :) I think it's all good now, just going to wait for CI. Thank you for doing this! I'm going to compare the HTML generated with mdbook 0.2.3 and github master next, I'm excited to see if #199 is actually fixed :) |
Update mdbook This updates to mdbook 0.3.0. This release includes the following changes: https://github.com/rust-lang-nursery/mdBook/blob/master/CHANGELOG.md#mdbook-030 One of the biggest changes is the update to pulldown-cmark. This also bumps the submodules (except the nomicon which has some broken links). ## reference 6 commits in f8ae436..08ae27a 2019-05-31 14:59:12 +0200 to 2019-06-17 11:24:13 -0700 - Document `underscore_const_names` (rust-lang/reference#620) - Describe `#[repr(align(x))]` semantics on `enum`s (rust-lang/reference#619) - Fix typo in lazy_static example. (rust-lang/reference#622) - Rust 2015 supports Kleene ? macro operator (rust-lang/reference#617) - Bitrig support has been removed (rust-lang/reference#615) - Fix spell error in attributes/diagnostics.md (rust-lang/reference#614) ## book 8 commits in 62a8c6f25fbd981c80a046f3b04be9684749af3b..9aacfcc4c5b102c8cda195932addefd32fe955d2 2019-05-28 15:48:23 -0400 to 2019-06-16 21:27:26 -0400 - Add a script to help diff rendered books - Update mdbook links (rust-lang/book#1989) - Update for markdown changes. (rust-lang/book#1984) - Make all mentions of crates.io consistent - Propagate corrections made in layout - Add link to Swedish translation - Propagate small edits made in layout - Remove snapshot files that have been checked with layout ## rust-by-example 3 commits in d8eec1dd65470b9a68e80ac1cba8fad0daac4916..b27472962986e85c94f4183b1a6d2207660d3ed6 2019-06-08 10:15:22 -0300 to 2019-06-17 15:52:07 -0300 - Update `macro_rules!` formatting. (rust-lang/rust-by-example#1205) - Add Cargo comment to the `try!` macro example. (rust-lang/rust-by-example#1203) - Fix typo (rust-lang/rust-by-example#1204) ## rustc-guide 15 commits in 3ac9cfc9c9ab2e366feebf18718112737f572352..f55e97c145cf37fd664db2e0e2f2d05df328bf4f 2019-06-02 19:36:58 -0500 to 2019-06-15 17:29:12 -0500 - fix typos - Update for TyCtxt<'a, 'gcx, 'tcx> -> TyCtxt<'tcx>. - fix ci failures, typos, broken links - Some edits to address review comments - Notes about closure de-sugaring - add note about rebuilding llvm - Changes to config.toml require a clean - Fix a few typos in type inference chapter - Add triagebot (rust-lang/rustc-dev-guide#337) - Update how-to-build-and-run.md - Update how-to-build-and-run.md - Update compiler-debugging.md - use debug instead of debuginfo-level - Replaced tabs with spaces - correct indentation ## edition-guide 4 commits in 581c6cccfaf995394ea9dcac362dc8e731c18558..f8072acde5ce29c7570d7986180bbded2d22e287 2019-05-06 12:47:44 -0700 to 2019-06-14 23:27:05 +0200 - Small fixes (rust-lang/edition-guide#179) - Cleanup unused NLL link (rust-lang/edition-guide#167) - Part 2: Rust 2015 now supports ? macro rep op (rust-lang/edition-guide#163) - Part 1: Rust 2015 now supports ? macro rep op (rust-lang/edition-guide#162) ## embedded-book 1 commits in f0c75b75f9c18537b78f5d17c1015247e9a49c86..ef27b517dcd0b990c888c0d7caeff52a5a115619 2019-06-03 10:49:02 +0000 to 2019-06-18 22:59:47 +0000 - Fix link for more strict commonmark interpretation. (rust-embedded/book#194)
mdbook will be moving to a newer version of pulldown-cmark soon which will result in some changes to rendering. This PR should keep the book compatible with both 0.2.3 and the future, unreleased version. There shouldn't be any visual regressions with either 0.2.3 or the new version. The specific issues are:
pulldown-cmark more strictly interprets the spec for link labels. No space is allowed between the text and label (https://spec.commonmark.org/0.29/#example-538).
There is an issue with interpreting pipes in tables. Switching to HTML entities should keep it compatible with both versions, resulting in the same visual output.
I re-wrapped all the paragraphs, though it caused some awkward wrapping in some spots. Presumably that was the reason why the newlines were added originally?
The
remove_links
script seems to have some problems, so I'm not sure if I should be more careful with the<-- ignore -->
comments. It currently crashes with "could not find url for the link text" on a bunch of pages. With these changes, it actually crashes less often, but there are still a few pages that have issues. I'm not sure ifignore
is still used.