Building documentation using recent versions of mdBo... | void-linux/void-docs

Nessuno ha ancora preso questa 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/:

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)
The selected chapter is not highlighted like in https://docs.voidlinux.org/:
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:

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.

Collapse/uncollapse animations would be added.

These are easy to patch out.
The selected chapter would also have to be remodified.
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.

Inizia con il tema personalizzato in src/theme/, in particolare con src/theme/index.hbs intorno all'uso di {{#toc}}{{/toc}}, e confrontalo con il comportamento recente del tema di mdBook. Compila void-docs con mdBook v0.4.43 e verifica i link della barra laterale e l'evidenziazione del capitolo selezionato rispetto a docs.voidlinux.org. Una modifica completa dovrebbe anche tenere conto dell'aggiornamento del container infra-mdbook e del revbumping di void-docs.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Building documentation using recent versions of mdBook is slightly broken

Descrizione

Cause

Relevant mdBook versions

Void's changes to mdBook's default theme

Possible solutions

Things to consider after solving this issue

Guida per i contributori

Come iniziare

Direzione di ricerca

Valutazione

Building documentation using recent versions of mdBook is slightly broken

Descrizione

Cause

Relevant mdBook versions

Void's changes to mdBook's default theme

Possible solutions

Things to consider after solving this issue

Guida per i contributori

Come iniziare

Direzione di ricerca

Valutazione

Ricevi le nuove issue nella tua casella