Skip to content

use mdbook-legacy as a workaround for compatibility issues #881

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.

Sign up for GitHub

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

Merged
classabbyamp merged 2 commits into from
Jan 13, 2026
Merged

use mdbook-legacy as a workaround for compatibility issues #881

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96b03ad
use mdbook-legacy as a workaround for compatibility issues
classabbyamp Jan 12, 2026
94aa0af
book.toml: add gnu.org to linkcheck exclusions
classabbyamp Jan 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ jobs:
run: |
xbps-install -Syu || xbps-install -Syu xbps
xbps-install -yu
xbps-install -y mdbook-linkcheck bash git
xbps-install -y mdBook-legacy mdbook-linkcheck bash git
- name: Checkout
id: checkout
uses: classabbyamp/treeless-checkout-action@v1
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ You can then edit the repository files as appropriate.

### Making changes

To serve the docs locally and view your changes, run `mdbook serve` from the
To serve the docs locally and view your changes, run `mdbook-legacy serve` from the
root of the repository.

Once you're satisfied with your changes, run the `check.sh` script provided in
Expand Down
3 changes: 2 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
PREFIX := /usr/local

MDBOOK := /usr/bin/mdbook-legacy
SOURCES = $(shell find src -not -path 'src/theme*' -type f -name '*.md')
MANPAGES = $(subst src/,book/mandoc/,$(patsubst %.md,%.7,$(SOURCES)))
UTILS = book/void-docs book/void-docs.1
Expand All @@ -25,7 +26,7 @@ $(UTILS): book/%: res/%.in book
sed -e "s,@PREFIX@,$(PREFIX)," $< >$@

void-book: $(SOURCES) book/typst/handbook-cover.svg
mdbook build
$(MDBOOK) build

book/typst/handbook-cover.svg: res/handbook-cover.svg book/typst
cp -a $< $@
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ the same protocol as the packages tree. For details, please read
The `Makefile` builds HTML, roff and PDF versions of the Void documentation and
the `void-docs.1` man page. It requires the following Void packages:

- `mdBook`
- `mdBook-legacy`
- `findutils`
- `lowdown` (version 0.8.1 or greater)
- `mdbook-typst`
Expand Down
1 change: 1 addition & 0 deletions book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,5 +75,6 @@ exclude = [
'canonical\.com',
'freedesktop\.org',
'libressl\.org',
'gnu\.org',
]
user-agent = "Mozilla/5.0"
4 changes: 2 additions & 2 deletions check.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ fi

vmdfmt -l -w src/

if command -v mdbook >/dev/null 2>&1; then
if command -v mdbook-legacy >/dev/null 2>&1; then
echo "Building book and checking links with mdbook ..."
mdbook build
mdbook-legacy build
else
echo "Checking links with mdbook-linkcheck ..."
mdbook-linkcheck -s
Expand Down