Skip to content

book: update config for mdbook 0.5 #6379

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
nwt merged 1 commit into from
Nov 20, 2025
Merged

book: update config for mdbook 0.5 #6379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion book/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
book
theme

package-lock.json
src/super.wasm
Expand Down
5 changes: 0 additions & 5 deletions book/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,6 @@ You'll need `mdbook`. Install it with brew
brew install mdbook
```

You'll also need the "table of contents" preprocessor. Install it with cargo
```
cargo install mdbook-pagetoc
```

The easiest way to work on docs is to run an mdbook service in this directory
and point your browser at its embedded web server, e.g.,
```
Expand Down
10 changes: 2 additions & 8 deletions book/book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,10 @@ title = "SuperDB"
[output.html.fold]
enable = true

[preprocessor.pagetoc]

[output.html]
additional-css = ["super-example/super-example.css", "copy-button/copy-button.css", "theme/pagetoc.css"]
additional-js = ["super-example.bundle.js", "copy-button/copy-button.js", "theme/pagetoc.js"]
additional-css = ["super-example/super-example.css", "copy-button/copy-button.css"]
additional-js = ["super-example.bundle.js", "copy-button/copy-button.js"]
git-repository-url = "https://github.com/brimdata/super/tree/main/book"
# This directive embeds content hashes in the certain asset file names
# to work around a problem where cached files cause the sidebar not to reflect
# changes to SUMMARY.md. See https://github.com/rust-lang/mdBook/issues/2547
hash-files = true
no-section-label = true

[output.html.playground]
Expand Down
Loading