Skip to content

Commit b3a1c19

Browse files
committed
use mdbook-legacy as a workaround for compatibility issues
Ref: #840 Ref: #841
1 parent ea2d763 commit b3a1c19

File tree

5 files changed

+7
-6
lines changed

5 files changed

+7
-6
lines changed

.github/workflows/ci.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ jobs:
5151
run: |
5252
xbps-install -Syu || xbps-install -Syu xbps
5353
xbps-install -yu
54-
xbps-install -y mdbook-linkcheck bash git
54+
xbps-install -y mdBook-legacy mdbook-linkcheck bash git
5555
- name: Checkout
5656
id: checkout
5757
uses: classabbyamp/treeless-checkout-action@v1

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ You can then edit the repository files as appropriate.
327327

328328
### Making changes
329329

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

333333
Once you're satisfied with your changes, run the `check.sh` script provided in

Makefile

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
PREFIX := /usr/local
22

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

2728
void-book: $(SOURCES) book/typst/handbook-cover.svg
28-
mdbook build
29+
$(MDBOOK) build
2930

3031
book/typst/handbook-cover.svg: res/handbook-cover.svg book/typst
3132
cp -a $< $@

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ the same protocol as the packages tree. For details, please read
1010
The `Makefile` builds HTML, roff and PDF versions of the Void documentation and
1111
the `void-docs.1` man page. It requires the following Void packages:
1212

13-
- `mdBook`
13+
- `mdBook-legacy`
1414
- `findutils`
1515
- `lowdown` (version 0.8.1 or greater)
1616
- `mdbook-typst`

check.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ fi
6060

6161
vmdfmt -l -w src/
6262

63-
if command -v mdbook >/dev/null 2>&1; then
63+
if command -v mdbook-legacy >/dev/null 2>&1; then
6464
echo "Building book and checking links with mdbook ..."
65-
mdbook build
65+
mdbook-legacy build
6666
else
6767
echo "Checking links with mdbook-linkcheck ..."
6868
mdbook-linkcheck -s

0 commit comments

Comments
 (0)