Merge pull request #2497 from ehuss/bump-version

Update to 0.4.43
2025-12-28 13:51:10 -05:00 · 2024-11-25 17:21:18 +00:00 · 2024-11-25 09:14:43 -08:00 · 2024-11-25 16:05:27 +00:00 · 2024-11-23 15:25:29 -08:00 · 2024-11-18 19:25:00 +00:00
11 changed files with 117 additions and 66 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,8 +1,31 @@
 # Changelog

+## mdBook 0.4.43
+[v0.4.42...v0.4.43](https://github.com/rust-lang/mdBook/compare/v0.4.42...v0.4.43)
+
+### Fixed
+
+- Fixed setting the title in `mdbook init` when no git user is configured.
+  [#2486](https://github.com/rust-lang/mdBook/pull/2486)
+
+### Changed
+
+- The Rust 2024 edition no longer needs `-Zunstable-options`.
+  [#2495](https://github.com/rust-lang/mdBook/pull/2495)
+
+## mdBook 0.4.42
+[v0.4.41...v0.4.42](https://github.com/rust-lang/mdBook/compare/v0.4.41...v0.4.42)
+
+### Fixed
+
+- Fixed chapter list folding.
+  [#2473](https://github.com/rust-lang/mdBook/pull/2473)
+
 ## mdBook 0.4.41
 [v0.4.40...v0.4.41](https://github.com/rust-lang/mdBook/compare/v0.4.40...v0.4.41)

+**Note:** If you have a custom `index.hbs` theme file, you will need to update it to the latest version.
+
 ### Added

 - Added preliminary support for Rust 2024 edition.
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -1139,7 +1139,7 @@ dependencies = [

 [[package]]
 name = "mdbook"
-version = "0.4.41"
+version = "0.4.43"
 dependencies = [
 "ammonia",
 "anyhow",
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -3,7 +3,7 @@ members = [".", "examples/remove-emphasis/mdbook-remove-emphasis"]

 [package]
 name = "mdbook"
-version = "0.4.41"
+version = "0.4.43"
 authors = [
    "Mathieu David <mathieudavid@mathieudavid.org>",
    "Michael-F-Bryan <michaelfbryan@gmail.com>",
--- a/guide/src/continuous-integration.md
+++ b/guide/src/continuous-integration.md
@@ -21,7 +21,7 @@ A simple approach would be to use the popular `curl` CLI tool to download the ex

 ```sh
 mkdir bin
-curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.41/mdbook-v0.4.41-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin
+curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.43/mdbook-v0.4.43-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin
 bin/mdbook build
 ```

--- a/src/book/mod.rs
+++ b/src/book/mod.rs
@@ -346,7 +346,7 @@ impl MDBook {
                            cmd.args(["--edition", "2021"]);
                        }
                        RustEdition::E2024 => {
-                            cmd.args(["--edition", "2024", "-Zunstable-options"]);
+                            cmd.args(["--edition", "2024"]);
                        }
                    }
                }
--- a/src/cmd/init.rs
+++ b/src/cmd/init.rs
@@ -74,9 +74,9 @@ pub fn execute(args: &ArgMatches) -> Result<()> {
    if let Some(author) = get_author_name() {
        debug!("Obtained user name from gitconfig: {:?}", author);
        config.book.authors.push(author);
-        builder.with_config(config);
    }

+    builder.with_config(config);
    builder.build()?;
    println!("\nAll done, no errors...");

--- a/src/theme/book.js
+++ b/src/theme/book.js
@@ -463,17 +463,6 @@ function playground_text(playground, hidden = true) {
        try { localStorage.setItem('mdbook-sidebar', 'visible'); } catch (e) { }
    }

-
-    var sidebarAnchorToggles = document.querySelectorAll('#sidebar a.toggle');
-
-    function toggleSection(ev) {
-        ev.currentTarget.parentElement.classList.toggle('expanded');
-    }
-
-    Array.from(sidebarAnchorToggles).forEach(function (el) {
-        el.addEventListener('click', toggleSection);
-    });
-
    function hideSidebar() {
        body.classList.remove('sidebar-visible')
        body.classList.add('sidebar-hidden');
--- a/src/theme/index.hbs
+++ b/src/theme/index.hbs
@@ -52,15 +52,17 @@
        <!-- MathJax -->
        <script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
        {{/if}}
-    </head>
-    <body>
-    <div id="body-container">
+
        <!-- Provide site root to javascript -->
        <script>
            var path_to_root = "{{ path_to_root }}";
            var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "{{ preferred_dark_theme }}" : "{{ default_theme }}";
        </script>
-
+        <!-- Start loading toc.js asap -->
+        <script src="{{ path_to_root }}toc.js"></script>
+    </head>
+    <body>
+    <div id="body-container">
        <!-- Work around some values being stored in localStorage wrapped in quotes -->
        <script>
            try {
@@ -107,7 +109,7 @@

        <nav id="sidebar" class="sidebar" aria-label="Table of contents">
            <!-- populated by js -->
-            <div class="sidebar-scrollbox"></div>
+            <mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
            <noscript>
                <iframe class="sidebar-iframe-outer" src="{{ path_to_root }}toc.html"></iframe>
            </noscript>
@@ -116,8 +118,6 @@
            </div>
        </nav>

-        <script async src="{{ path_to_root }}toc.js"></script>
-
        <div id="page-wrapper" class="page-wrapper">

            <div class="page">
--- a/src/theme/toc.js.hbs
+++ b/src/theme/toc.js.hbs
@@ -3,52 +3,68 @@
 // This is a script, and not included directly in the page, to control the total size of the book.
 // The TOC contains an entry for each page, so if each page includes a copy of the TOC,
 // the total size of the page becomes O(n**2).
-var sidebarScrollbox = document.querySelector("#sidebar .sidebar-scrollbox");
-sidebarScrollbox.innerHTML = '{{#toc}}{{/toc}}';
-(function() {
-    let current_page = document.location.href.toString();
-    if (current_page.endsWith("/")) {
-        current_page += "index.html";
+class MDBookSidebarScrollbox extends HTMLElement {
+    constructor() {
+        super();
    }
-    var links = sidebarScrollbox.querySelectorAll("a");
-    var l = links.length;
-    for (var i = 0; i < l; ++i) {
-        var link = links[i];
-        var href = link.getAttribute("href");
-        if (href && !href.startsWith("#") && !/^(?:[a-z+]+:)?\/\//.test(href)) {
-            link.href = path_to_root + href;
+    connectedCallback() {
+        this.innerHTML = '{{#toc}}{{/toc}}';
+        // Set the current, active page, and reveal it if it's hidden
+        let current_page = document.location.href.toString();
+        if (current_page.endsWith("/")) {
+            current_page += "index.html";
        }
-        // The "index" page is supposed to alias the first chapter in the book.
-        if (link.href === current_page || (i === 0 && path_to_root === "" && current_page.endsWith("/index.html"))) {
-            link.classList.add("active");
-            var parent = link.parentElement;
-            while (parent) {
-                if (parent.tagName === "LI" && parent.previousElementSibling) {
-                    if (parent.previousElementSibling.classList.contains("chapter-item")) {
-                        parent.previousElementSibling.classList.add("expanded");
-                    }
+        var links = Array.prototype.slice.call(this.querySelectorAll("a"));
+        var l = links.length;
+        for (var i = 0; i < l; ++i) {
+            var link = links[i];
+            var href = link.getAttribute("href");
+            if (href && !href.startsWith("#") && !/^(?:[a-z+]+:)?\/\//.test(href)) {
+                link.href = path_to_root + href;
+            }
+            // The "index" page is supposed to alias the first chapter in the book.
+            if (link.href === current_page || (i === 0 && path_to_root === "" && current_page.endsWith("/index.html"))) {
+                link.classList.add("active");
+                var parent = link.parentElement;
+                if (parent && parent.classList.contains("chapter-item")) {
+                    parent.classList.add("expanded");
+                }
+                while (parent) {
+                    if (parent.tagName === "LI" && parent.previousElementSibling) {
+                        if (parent.previousElementSibling.classList.contains("chapter-item")) {
+                            parent.previousElementSibling.classList.add("expanded");
+                        }
+                    }
+                    parent = parent.parentElement;
                }
-                parent = parent.parentElement;
            }
        }
-    }
-})();
-
-// Track and set sidebar scroll position
-sidebarScrollbox.addEventListener('click', function(e) {
-    if (e.target.tagName === 'A') {
-        sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
-    }
-}, { passive: true });
-var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
-sessionStorage.removeItem('sidebar-scroll');
-if (sidebarScrollTop) {
-    // preserve sidebar scroll position when navigating via links within sidebar
-    sidebarScrollbox.scrollTop = sidebarScrollTop;
-} else {
-    // scroll sidebar to current active section when navigating via "next/previous chapter" buttons
-    var activeSection = document.querySelector('#sidebar .active');
-    if (activeSection) {
-        activeSection.scrollIntoView({ block: 'center' });
+        // Track and set sidebar scroll position
+        this.addEventListener('click', function(e) {
+            if (e.target.tagName === 'A') {
+                sessionStorage.setItem('sidebar-scroll', this.scrollTop);
+            }
+        }, { passive: true });
+        var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
+        sessionStorage.removeItem('sidebar-scroll');
+        if (sidebarScrollTop) {
+            // preserve sidebar scroll position when navigating via links within sidebar
+            this.scrollTop = sidebarScrollTop;
+        } else {
+            // scroll sidebar to current active section when navigating via "next/previous chapter" buttons
+            var activeSection = document.querySelector('#sidebar .active');
+            if (activeSection) {
+                activeSection.scrollIntoView({ block: 'center' });
+            }
+        }
+        // Toggle buttons
+        var sidebarAnchorToggles = document.querySelectorAll('#sidebar a.toggle');
+        function toggleSection(ev) {
+            ev.currentTarget.parentElement.classList.toggle('expanded');
+        }
+        Array.from(sidebarAnchorToggles).forEach(function (el) {
+            el.addEventListener('click', toggleSection);
+        });
    }
 }
+window.customElements.define("mdbook-sidebar-scrollbox", MDBookSidebarScrollbox);
--- a/tests/cli/init.rs
+++ b/tests/cli/init.rs
@@ -22,3 +22,26 @@ fn base_mdbook_init_can_skip_confirmation_prompts() {

    assert!(!temp.path().join(".gitignore").exists());
 }
+
+/// Run `mdbook init` with `--title` without git config.
+///
+/// Regression test for https://github.com/rust-lang/mdBook/issues/2485
+#[test]
+fn no_git_config_with_title() {
+    let temp = DummyBook::new().build().unwrap();
+
+    // doesn't exist before
+    assert!(!temp.path().join("book").exists());
+
+    let mut cmd = mdbook_cmd();
+    cmd.args(["init", "--title", "Example title"])
+        .current_dir(temp.path())
+        .env("GIT_CONFIG_GLOBAL", "")
+        .env("GIT_CONFIG_NOSYSTEM", "1");
+    cmd.assert()
+        .success()
+        .stdout(predicates::str::contains("\nAll done, no errors...\n"));
+
+    let config = Config::from_disk(temp.path().join("book.toml")).unwrap();
+    assert_eq!(config.book.title.as_deref(), Some("Example title"));
+}
--- a/tests/rendered_output.rs
+++ b/tests/rendered_output.rs
@@ -243,7 +243,7 @@ fn toc_js_html() -> Result<Document> {
    let toc_path = temp.path().join("book").join("toc.js");
    let html = fs::read_to_string(toc_path).with_context(|| "Unable to read index.html")?;
    for line in html.lines() {
-        if let Some(left) = line.strip_prefix("sidebarScrollbox.innerHTML = '") {
+        if let Some(left) = line.strip_prefix("        this.innerHTML = '") {
            if let Some(html) = left.strip_suffix("';") {
                return Ok(Document::from(html));
            }
Author	SHA1	Message	Date
Eric Huss	74b2c79d46	Merge pull request #2497 from ehuss/bump-version Update to 0.4.43	2024-11-25 17:21:18 +00:00
Eric Huss	ed407b091c	Update to 0.4.43	2024-11-25 09:14:43 -08:00
Eric Huss	6c8020a3b9	Merge pull request #2495 from ehuss/stabilize-2024 Stabilize 2024 flag	2024-11-25 16:05:27 +00:00
Eric Huss	42f18d1e51	Stabilize 2024 flag The 2024 edition is now stable on nightly, so the `-Z` flag is no longer necessary.	2024-11-23 15:25:29 -08:00
Eric Huss	d1078434af	Merge pull request #2486 from eureka-cpu/eureka-cpu/2485 fix `init --title` option failure when git user is not configured	2024-11-18 19:25:00 +00:00
eureka-cpu	8f024dabc3	fix init --title option failure when git user is not configured	2024-11-18 11:10:11 -08:00
Eric Huss	0c580c32c4	Add regression test for mdbook init title with no git config Regression test for https://github.com/rust-lang/mdBook/issues/2485	2024-11-18 11:08:26 -08:00
Eric Huss	90960126e8	Merge pull request #2478 from rust-lang/ehuss-patch-1 Add note about updating `index.hbs`	2024-11-09 13:47:04 +00:00
Eric Huss	aa37f24fc1	Add note about updating `index.hbs`	2024-11-09 05:40:12 -08:00
Eric Huss	3f4f287e6e	Merge pull request #2474 from ehuss/bump-version Update to 0.4.42	2024-11-07 14:49:21 +00:00
Eric Huss	55fe75c716	Update to 0.4.42	2024-11-07 06:42:05 -08:00
Eric Huss	c6236ead67	Merge pull request #2473 from notriddle/notriddle/folding Fix inadvertently broken folding behavior	2024-11-07 14:39:31 +00:00
Michael Howell	68e3572278	Fix inadvertently broken folding behavior	2024-11-06 15:47:12 -07:00