Fix release script LTO.

Merge pull request #1299 from ehuss/release-next
Release 0.4.2
2025-12-28 20:53:02 -05:00 · 2020-08-11 15:39:03 -07:00 · 2020-08-11 15:28:01 -07:00 · 2020-08-11 15:19:39 -07:00 · 2020-08-10 10:46:53 -07:00 · 2020-08-10 10:52:22 +02:00
14 changed files with 109 additions and 19 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,25 @@
 # Changelog

+## mdBook 0.4.2
+[649f355...9278b83](https://github.com/rust-lang/mdBook/compare/649f355...9278b83)
+
+### Changed
+- The "show hidden lines" icon has changed from the "expand" icon to an "eye".
+  [#1281](https://github.com/rust-lang/mdBook/pull/1281)
+- Updated highlight.js. This adds several languages: c, c-like (effectively
+  cpp), csharp (replaces cs), kotlin, less, lua, php-template, plaintext,
+  python-repl, r, scss, typescript.
+  [#1277](https://github.com/rust-lang/mdBook/pull/1277)
+
+### Fixed
+- Fixed SUMMARY links that contained newlines.
+  [#1291](https://github.com/rust-lang/mdBook/pull/1291)
+- Fixed SUMMARY links that contain `%20` spaces.
+  [#1293](https://github.com/rust-lang/mdBook/pull/1293)
+- Fixed favicon so that if only the png or svg is overridden, the other is not
+  automatically included in the `<link>` tag.
+  [#1272](https://github.com/rust-lang/mdBook/pull/1272)
+
 ## mdBook 0.4.1
 [d4df7e7...649f355](https://github.com/rust-lang/mdBook/compare/d4df7e7...649f355)

@@ -30,6 +50,8 @@
  can disable the 404 page generation, or set up your own 404 handling in your
  web server.
  [#1221](https://github.com/rust-lang/mdBook/pull/1221)
+- The `debug` and `output` features have been removed as they were unused.
+  [#1211](https://github.com/rust-lang/mdBook/pull/1211)
 - If you are using customized themes, you may want to consider setting the
  `preferred-dark-theme` config setting, as it now defaults to "navy".
  [#1199](https://github.com/rust-lang/mdBook/pull/1199)
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -723,7 +723,7 @@ checksum = "7ffc5c5338469d4d3ea17d269fa8ea3512ad247247c30bd2df69e68309ed0a08"

 [[package]]
 name = "mdbook"
-version = "0.4.1"
+version = "0.4.2"
 dependencies = [
 "ammonia",
 "anyhow",
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mdbook"
-version = "0.4.1"
+version = "0.4.2"
 authors = [
    "Mathieu David <mathieudavid@mathieudavid.org>",
    "Michael-F-Bryan <michaelfbryan@gmail.com>",
--- a/book-example/src/README.md
+++ b/book-example/src/README.md
@@ -1,8 +1,8 @@
 # mdBook

 **mdBook** is a command line tool and Rust crate to create books using Markdown
-files. It's very similar to Gitbook but written in
-[Rust](http://www.rust-lang.org).
+(as by the [CommonMark](https://commonmark.org/) specification) files. It's very
+similar to Gitbook but written in [Rust](http://www.rust-lang.org).

 What you are reading serves as an example of the output of mdBook and at the
 same time as a high-level documentation.
--- a/book-example/src/for_developers/backends.md
+++ b/book-example/src/for_developers/backends.md
@@ -334,7 +334,9 @@ the usual `RUST_LOG` to control logging verbosity.
 If you enable a backend that isn't installed, the default behavior is to throw an error:

 ```text
-The command wasn't found, is the "wordcount" backend installed?
+The command `mdbook-wordcount` wasn't found, is the "wordcount" backend installed?
+If you want to ignore this error when the "wordcount" backend is not installed,
+set `optional = true` in the `[output.wordcount]` section of the book.toml configuration file.
 ```

 This behavior can be changed by marking the backend as optional.
--- a/book-example/src/format/theme/index-hbs.md
+++ b/book-example/src/format/theme/index-hbs.md
@@ -19,7 +19,8 @@ Here is a list of the properties that are exposed:

 - ***language*** Language of the book in the form `en`, as specified in `book.toml` (if not specified, defaults to `en`). To use in <code
  class="language-html">\<html lang="{{ language }}"></code> for example.
- ***title*** Title of the book, as specified in `book.toml`
+- ***title*** Title used for the current page. This is identical to `{{ book_title }} - {{ chapter_title }}` unless `book_title` is not set in which case it just defaults to the `chapter_title`.
+- ***book_title*** Title of the book, as specified in `book.toml`
 - ***chapter_title*** Title of the current chapter, as listed in `SUMMARY.md`

 - ***path*** Relative path to the original markdown file from the source
--- a/ci/install-rust.sh
+++ b/ci/install-rust.sh
@@ -12,7 +12,7 @@ TOOLCHAIN="$1"

 rustup set profile minimal
 rustup component remove --toolchain=$TOOLCHAIN rust-docs || echo "already removed"
-rustup update $TOOLCHAIN
+rustup update --no-self-update $TOOLCHAIN
 rustup default $TOOLCHAIN
 rustup -V
 rustc -Vv
--- a/ci/make-release.sh
+++ b/ci/make-release.sh
@@ -11,7 +11,8 @@ fi
 TAG=${GITHUB_REF#*/tags/}

 host=$(rustc -Vv | grep ^host: | sed -e "s/host: //g")
-cargo rustc --bin mdbook --release -- -C lto
+export CARGO_PROFILE_RELEASE_LTO=true
+cargo build --bin mdbook --release
 cd target/release
 case $1 in
  ubuntu* | macos*)
--- a/src/book/summary.rs
+++ b/src/book/summary.rs
@@ -333,6 +333,7 @@ impl<'a> SummaryParser<'a> {

    /// Finishes parsing a link once the `Event::Start(Tag::Link(..))` has been opened.
    fn parse_link(&mut self, href: String) -> Link {
+        let href = href.replace("%20", " ");
        let link_content = collect_events!(self.stream, end Tag::Link(..));
        let name = stringify_events(link_content);

@@ -569,6 +570,7 @@ fn stringify_events(events: Vec<Event<'_>>) -> String {
        .into_iter()
        .filter_map(|t| match t {
            Event::Text(text) | Event::Code(text) => Some(text.into_string()),
+            Event::SoftBreak => Some(String::from(" ")),
            _ => None,
        })
        .collect()
@@ -926,4 +928,49 @@ mod tests {

        assert_eq!(got, should_be);
    }
+
+    /// Regression test for https://github.com/rust-lang/mdBook/issues/1218
+    /// Ensure chapter names spread across multiple lines have spaces between all the words.
+    #[test]
+    fn add_space_for_multi_line_chapter_names() {
+        let src = "- [Chapter\ntitle](./chapter.md)";
+        let should_be = vec![SummaryItem::Link(Link {
+            name: String::from("Chapter title"),
+            location: Some(PathBuf::from("./chapter.md")),
+            number: Some(SectionNumber(vec![1])),
+            nested_items: Vec::new(),
+        })];
+
+        let mut parser = SummaryParser::new(src);
+        let got = parser
+            .parse_numbered(&mut 0, &mut SectionNumber::default())
+            .unwrap();
+
+        assert_eq!(got, should_be);
+    }
+
+    #[test]
+    fn allow_space_in_link_destination() {
+        let src = "- [test1](./test%20link1.md)\n- [test2](<./test link2.md>)";
+        let should_be = vec![
+            SummaryItem::Link(Link {
+                name: String::from("test1"),
+                location: Some(PathBuf::from("./test link1.md")),
+                number: Some(SectionNumber(vec![1])),
+                nested_items: Vec::new(),
+            }),
+            SummaryItem::Link(Link {
+                name: String::from("test2"),
+                location: Some(PathBuf::from("./test link2.md")),
+                number: Some(SectionNumber(vec![2])),
+                nested_items: Vec::new(),
+            }),
+        ];
+        let mut parser = SummaryParser::new(src);
+        let got = parser
+            .parse_numbered(&mut 0, &mut SectionNumber::default())
+            .unwrap();
+
+        assert_eq!(got, should_be);
+    }
 }
--- a/src/renderer/html_handlebars/hbs_renderer.rs
+++ b/src/renderer/html_handlebars/hbs_renderer.rs
@@ -478,7 +478,7 @@ impl Renderer for HtmlHandlebars {
        debug!("Register handlebars helpers");
        self.register_hbs_helpers(&mut handlebars, &html_config);

-        let mut data = make_data(&ctx.root, &book, &ctx.config, &html_config)?;
+        let mut data = make_data(&ctx.root, &book, &ctx.config, &html_config, &theme)?;

        // Print version
        let mut print_content = String::new();
@@ -551,6 +551,7 @@ fn make_data(
    book: &Book,
    config: &Config,
    html_config: &HtmlConfig,
+    theme: &Theme,
 ) -> Result<serde_json::Map<String, serde_json::Value>> {
    trace!("make_data");

@@ -567,6 +568,12 @@ fn make_data(
        "description".to_owned(),
        json!(config.book.description.clone().unwrap_or_default()),
    );
+    if theme.favicon_png.is_some() {
+        data.insert("favicon_png".to_owned(), json!("favicon.png"));
+    }
+    if theme.favicon_svg.is_some() {
+        data.insert("favicon_svg".to_owned(), json!("favicon.svg"));
+    }
    if let Some(ref livereload) = html_config.livereload_url {
        data.insert("livereload".to_owned(), json!(livereload));
    }
--- a/src/renderer/mod.rs
+++ b/src/renderer/mod.rs
@@ -173,7 +173,9 @@ impl CmdRenderer {
                return Ok(());
            } else {
                error!(
-                    "The command `{}` wasn't found, is the `{}` backend installed?",
+                    "The command `{0}` wasn't found, is the \"{1}\" backend installed? \
+                    If you want to ignore this error when the \"{1}\" backend is not installed, \
+                    set `optional = true` in the `[output.{1}]` section of the book.toml configuration file.",
                    self.cmd, self.name
                );
            }
--- a/src/theme/book.js
+++ b/src/theme/book.js
@@ -175,23 +175,23 @@ function playground_text(playground) {

        var buttons = document.createElement('div');
        buttons.className = 'buttons';
-        buttons.innerHTML = "<button class=\"fa fa-expand\" title=\"Show hidden lines\" aria-label=\"Show hidden lines\"></button>";
+        buttons.innerHTML = "<button class=\"fa fa-eye\" title=\"Show hidden lines\" aria-label=\"Show hidden lines\"></button>";

        // add expand button
        var pre_block = block.parentNode;
        pre_block.insertBefore(buttons, pre_block.firstChild);

        pre_block.querySelector('.buttons').addEventListener('click', function (e) {
-            if (e.target.classList.contains('fa-expand')) {
-                e.target.classList.remove('fa-expand');
-                e.target.classList.add('fa-compress');
+            if (e.target.classList.contains('fa-eye')) {
+                e.target.classList.remove('fa-eye');
+                e.target.classList.add('fa-eye-slash');
                e.target.title = 'Hide lines';
                e.target.setAttribute('aria-label', e.target.title);

                block.classList.remove('hide-boring');
-            } else if (e.target.classList.contains('fa-compress')) {
-                e.target.classList.remove('fa-compress');
-                e.target.classList.add('fa-expand');
+            } else if (e.target.classList.contains('fa-eye-slash')) {
+                e.target.classList.remove('fa-eye-slash');
+                e.target.classList.add('fa-eye');
                e.target.title = 'Show hidden lines';
                e.target.setAttribute('aria-label', e.target.title);

--- a/src/theme/highlight.js
+++ b/src/theme/highlight.js
--- a/src/theme/index.hbs
+++ b/src/theme/index.hbs
@@ -20,8 +20,12 @@
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <meta name="theme-color" content="#ffffff" />

+        {{#if favicon_svg}}
        <link rel="icon" href="{{ path_to_root }}favicon.svg">
+        {{/if}}
+        {{#if favicon_png}}
        <link rel="shortcut icon" href="{{ path_to_root }}favicon.png">
+        {{/if}}
        <link rel="stylesheet" href="{{ path_to_root }}css/variables.css">
        <link rel="stylesheet" href="{{ path_to_root }}css/general.css">
        <link rel="stylesheet" href="{{ path_to_root }}css/chrome.css">
Author	SHA1	Message	Date
Eric Huss	f6768b816c	Fix release script LTO.	2020-08-11 15:39:03 -07:00
Eric Huss	8f7e030ac3	Merge pull request #1299 from ehuss/release-next Release 0.4.2	2020-08-11 15:28:01 -07:00
Eric Huss	9180dd1659	Release 0.4.2	2020-08-11 15:19:39 -07:00
Eric Huss	9278b838a8	Merge pull request #1298 from FabienTregan/adding_info_about_markdown_flavor Adds information about markdown flavor in the documentation.	2020-08-10 10:46:53 -07:00
Fabien Tregan	2674347768	Adds information about markdown flavor in the documentation.	2020-08-10 10:52:22 +02:00
Eric Huss	3d44553671	Merge pull request #1293 from Evian-Zhang/master allow space in SUMMARY.md's link destination	2020-08-08 08:19:06 -07:00
Evian-Zhang	9d5c454e47	delete '+' replacement and use cargo fmt to format	2020-08-08 15:13:22 +08:00
Eric Huss	a00e7d1769	Merge pull request #1272 from ehuss/fix-favicon-link Fix favicon when only one is overridden.	2020-08-07 08:34:46 -07:00
Evian-Zhang	60be20a783	allow space in SUMMARY.md's link destination	2020-08-03 09:49:01 +08:00
Eric Huss	8746206060	Merge pull request #1284 from ericonr/opt Mention that uninstalled backend isn't marked optional.	2020-07-30 20:22:55 -07:00
Eric Huss	f5ae7c4f13	Merge pull request #1291 from ericonr/fix-break summary: turn SoftBreak events into spaces.	2020-07-30 20:05:07 -07:00
Érico Rolim	dcf9462d1e	summary: turn SoftBreak events into spaces. Summary items that had their name split into two lines ended up with the last word of one line and the first word of the next line glued together, since a space wasn't added. Added test case for it. Fixes #1218	2020-07-29 15:53:27 -03:00
Érico Rolim	78aa2a16f8	Mention that uninstalled backend isn't marked optional. If an uninstalled backend (command not found) isn't marked optional, warn about it, since it causes mdbook commands to error out. Fixes #1283	2020-07-28 18:08:32 -03:00
Eric Huss	303db0ddec	Merge pull request #1277 from maniyar1/patch-1 Update highlight.js	2020-07-21 14:17:03 -07:00
Eric Huss	a884c2574e	Merge pull request #1281 from onelson/more-obvious-show-hidden Change "show hidden lines" icon to "eye" instead of "expand."	2020-07-21 12:23:14 -07:00
maniyar1	60029e4e15	Add R-lang support	2020-07-20 19:03:29 -04:00
Yuki Okushi	4e16d96ed5	Mention removed features (#1282 )	2020-07-19 21:32:21 +02:00
Owen Nelson	0eefd63a13	Change "show hidden lines" icon to "eye" instead of "expand." In a recent discussion in the amethyst docs discord channel, it was suggested that using an "eye" icon might make the show hidden lines feature of mdbook's code sample rendering more discoverable. I myself overlooked the arrows that are in use now. Fixes #663 at least in part.	2020-07-16 19:27:18 -07:00
Eric Huss	89c2743cc6	Merge pull request #1280 from bikeshedder/fix-title-doc Fix documentation for title and book_title	2020-07-16 10:04:44 -07:00
Michael P. Jung	a825427722	Fix documentation for title and book_title	2020-07-16 16:43:46 +02:00
maniyar1	c99047bbda	Update highlight.js Updates to 10.1.1, with support for new languages added to the common set. Built with: common languages + D, handlebars, haskell, julia, scala, x86asm, armasm, yaml Size difference: New highlight.js: 132KiB Old highlight.js: 84KiB -- New highlight.js compressed: 48KiB Old highlight.js compressed: 36KiB	2020-07-09 14:01:51 -04:00
Eric Huss	20a0b99c3d	Fix favicon when only one is overridden. A mistake in #1266, I neglected to also update the <link> generation to elide the link if one of the favicon images is not included.	2020-07-08 12:44:07 -07:00
Eric Huss	ec495a7823	Merge pull request #1273 from ehuss/fix-ci-rustup Fix CI due to new rustup.	2020-07-08 10:59:14 -07:00
Eric Huss	e38fb1ecc6	Fix CI due to new rustup.	2020-07-07 14:08:51 -07:00