Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Building documentation using recent versions of mdBook is slightly broken

未关闭
  • 哪里不对？
#840 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
缺陷
描述清晰度
需要澄清
活跃度
停滞
技术栈
css, handlebars, javascript
领域
documentation, frontend

调研方向

从 src/theme/ 中的自定义主题开始，重点查看使用 {{#toc}}{{/toc}} 的 src/theme/index.hbs，并将其与 mdBook 最近的主题行为进行比较。使用 mdBook v0.4.43 构建 void-docs，并对照 docs.voidlinux.org 检查侧边栏链接和选中章节的高亮显示。完整的更改还应包括更新 infra-mdbook 容器以及对 void-docs 进行 revbump。

由索引模型根据 Issue 内容生成。

描述

This has been discussed in #voidlinux. Here is the original screen capture I posted there which showcases some of the problems:

https://github.com/user-attachments/assets/b90cbd47-aa59-4d7f-8afd-28b9919b9780

Trying to build void-docs with a recent version of mdBook (including v0.4.43 which is the version currently packaged in void-packages) will lead to the following quirks not present in https://docs.voidlinux.org/:

  1. Sidebar's links become broken (see https://github.com/rust-lang/mdBook/issues/2685) (this is probably the most severe problem affecting the usability of the documentation)

  2. The selected chapter is not highlighted like in https://docs.voidlinux.org/:

    sidebar with a selected chapter

  3. There are probably more issues (more minor or specific ones)

Local builds and the void-docs official package are affected.

Cause

This is caused by void-docs' custom theme which completely overrides mdBook's default sidebar logic. Void's substitute code relies on mdBook's toc helper, which endured a breaking change in newer versions of mdBook: https://github.com/rust-lang/mdBook/issues/2685

Relevant mdBook versions

void-docs' theme resides in src/theme/. Most of it was overhauled by 7281cedcdd99294c93d71f4ef33953bea22cc819. The commit description indicates that these files were made by taking mdBook's default theme files and modifying them to Void's needs.

The void-packages packaged version of mdBook was v0.4.14 at the time of making that commit, so mdBook v0.4.14 default theme files were most likely used as base for void-docs theme.

The Void infrastructure generates https://docs.voidlinux.org/ from the ghcr.io/void-linux/infra-mdbook:20231023R1 container (which is created from here using these files). The ghcr.io/void-linux/infra-mdbook:20231023R1 container includes mdBook v0.4.35, which doesn't suffer from the problem described in https://github.com/rust-lang/mdBook/issues/2685

Void's changes to mdBook's default theme

Here is a cleaned up diff (I had to reindent void-docs' theme) between mdBook v0.4.14 default theme files and void-docs' current theme files: void-docs-theme-changes.patch.txt

Possible solutions

The most straight forward solution to the sidebar problem would be to somehow convince the relative links generated in here by {{#toc}}{{/toc}} to be relative to path_to_root or to something similar. I personally do not know how to do that or whether it is possible.

Another solution would be to switch to mdBook's default sidebar logic. This would lead to less custom theme logic in void-docs. This would result in the following behavior changes:

  1. The sidebar would become scrollable, it would no longer be static.

    Most of the other features mentioned here can be relatively easily removed, but preserving the static nature of the sidebar would require heavy modification to mdBook's default sidebar logic (I assume, I haven't tried implementing it). In recent enough versions of mdBook, the sidebar is handled by

    <!DOCTYPE HTML>
<html lang="{{ language }}" class="{{ default_theme }} sidebar-visible" dir="{{ text_direction }}">
    <head>
        <!-- ... -->

        <!-- Start loading toc.js asap -->
        <script src="{{ resource "toc.js" }}"></script>
    </head>
    <body>
    <div id="body-container">
        <!-- ... -->

        <nav id="sidebar" class="sidebar" aria-label="Table of contents">
            <!-- populated by js -->
            <mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
            <noscript>
                <iframe class="sidebar-iframe-outer" src="{{ path_to_root }}toc.html"></iframe>
            </noscript>
            <div id="sidebar-resize-handle" class="sidebar-resize-handle">
                <div class="sidebar-resize-indicator"></div>
            </div>
        </nav>

        <!-- ... -->
    </div>
    </body>
</html>

    A JS version is managed by toc.js and a non-JS one is built by mdBook and outputted into toc.html.

    The toc.js file would likely have to be modified to preserve the original UI. This file is not one of the files overrideable by mdBook theme, so a custom one would have to be created, modified and shipped alongside the (unused) toc.js.

  2. Collapse/uncollapse animations would be added.

    These are easy to patch out.

  3. The selected chapter would also have to be remodified.

  4. The UI on mobile devices would presumably also be affected (I haven't tested it)

The non-JS toc.html file mentioned above might be usable as a replacement to {{#toc}}{{/toc}} if void-docs wishes to steer away from mdBook's default sidebar logic.

Things to consider after solving this issue

The ghcr.io/void-linux/infra-mdbook container will have to be updated.

Once that's done, this line will have to be updated to point to the new container. I am not closely familiar with Void's infrastructure, more steps may be necessary.

The void-docs package should be revbumped once this issue gets resolved.

主要语言
CSS
星标
219
派生
214
平均合并
2 天 21 小时
30 天内合并 PR
1

环境准备

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

void-linux/void-docs 的其他 Issue

查看 void-linux/void-docs 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。