aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeckoEidechse <gecko.eidechse+git@pm.me>2024-02-05 17:19:56 +0100
committerGeckoEidechse <gecko.eidechse+git@pm.me>2024-02-05 17:19:56 +0100
commit901553bac92a651fef888e6026f4c6cb44f9d1e8 (patch)
tree8a58752148e0dee9beafee22e55a53e92894f1ca
parent7f023c4770cf90916910f988619c544c25ec12f7 (diff)
downloadNorthstarWiki-901553bac92a651fef888e6026f4c6cb44f9d1e8.tar.gz
NorthstarWiki-901553bac92a651fef888e6026f4c6cb44f9d1e8.zip
Use gitbook preprocessor
-rw-r--r--README.md5
-rw-r--r--book.toml2
2 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index c3b70a6..fa6ae86 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,11 @@ 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.
+
#### 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)
diff --git a/book.toml b/book.toml
index b4b3256..8c1d5aa 100644
--- a/book.toml
+++ b/book.toml
@@ -11,3 +11,5 @@ title = "Northstar Wiki"
[output.linkcheck]
optional = true
+
+[preprocessor.gitbook]