Skip to content
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

Use gitbook preprocessor #282

Closed
wants to merge 6 commits into from
Closed

Use gitbook preprocessor #282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
901553b
Use gitbook preprocessor
GeckoEidechse Feb 5, 2024
5f67dde
docs: Add incomplete installation instructions
GeckoEidechse Feb 6, 2024
cadb9b4
Merge branch 'main' into docs/gitbook-preprocessor
GeckoEidechse Feb 10, 2024
12c6b37
Merge branch 'main' into docs/gitbook-preprocessor
GeckoEidechse Jul 14, 2024
00e9bb0
Merge branch 'main' into docs/gitbook-preprocessor
GeckoEidechse Aug 8, 2024
933942f
Merge branch 'main' into docs/gitbook-preprocessor
GeckoEidechse Sep 27, 2024
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
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ To install mdBook use the following link if:
- [you have Rust toolchain installed](https://rust-lang.github.io/mdBook/guide/installation.html#build-from-source-using-rust)
- [you **DON'T** have Rust toolchain installed](https://rust-lang.github.io/mdBook/guide/installation.html#pre-compiled-binaries)

#### mdBook-gitbook

GitBook uses some non-standard syntax to render certain widgets like embedded YouTube videos.
mdBook does not support these out of the box but there is a WIP extension that can render some of those similar to how GitBook does it.

To install mdBook-gitbook do the following link if:
- you have Rust toolchain installed: `cargo install mdbook-gitbook`
- you **DON'T** have Rust toolchain installed (TODO update me) (add `mdBook-gitbook.exe` to the same folder `mdBook.exe` is located)

#### mdBook-linkcheck
Additionally there's a community-made package that you can use alongside mdBook to show you some potentially broken links in markdown files called [`mdBook-linkcheck`](/~https://github.com/Michael-F-Bryan/mdbook-linkcheck)

Expand Down
2 changes: 2 additions & 0 deletions book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ title = "Northstar Wiki"

[output.linkcheck]
optional = true

[preprocessor.gitbook]