From 5f67dde760638eabdbfd329195e190e28def742b Mon Sep 17 00:00:00 2001 From: GeckoEidechse Date: Tue, 6 Feb 2024 16:38:02 +0100 Subject: docs: Add incomplete installation instructions --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index fa6ae86..4da3dc3 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,10 @@ To install mdBook use the following link if: 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) -- cgit v1.2.3