diff options
| author | GeckoEidechse <gecko.eidechse+git@pm.me> | 2024-02-06 16:38:02 +0100 |
|---|---|---|
| committer | GeckoEidechse <gecko.eidechse+git@pm.me> | 2024-02-06 16:38:02 +0100 |
| commit | 5f67dde760638eabdbfd329195e190e28def742b (patch) | |
| tree | a0e922cf1119cff7b3c6f1bf99cf50120792dc4c | |
| parent | 901553bac92a651fef888e6026f4c6cb44f9d1e8 (diff) | |
| download | NorthstarWiki-5f67dde760638eabdbfd329195e190e28def742b.tar.gz NorthstarWiki-5f67dde760638eabdbfd329195e190e28def742b.zip | |
docs: Add incomplete installation instructions
| -rw-r--r-- | README.md | 4 |
1 files changed, 4 insertions, 0 deletions
@@ -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) |