R2Northstar / NorthstarWiki

Wiki covering installation, hosting and configuration of Northstar
https://r2northstar.gitbook.io/
MIT License
34 stars 54 forks source link

Add instructions for building wiki locally #237

Closed GeckoEidechse closed 1 year ago

GeckoEidechse commented 1 year ago

mdbook works quite well for rendering the wiki locally.

It even uses the SUMMARY.md file as GitBook does. It does not have support for GitBook's custom syntax like

{% hint style="info" %}
Hello World!
{% endhint %}

instead just rendering it as text but that should still be close enough and is a definitive upgrade from using vscode or GitHub to preview changes.

itscynxx commented 1 year ago

The code for book.toml is foreign to me, but I'd imagine it's for making mdBook work which I'm all for

The layout on mdBook is quite different than gitbook, but is still 10x better than anything we currently have for previewing the wiki

I was gonna leave something mentioning installation on the page, but anyone who wants to go as far as to render the wiki locally should be able to see and read the installation section on the website If we really wanted to have a section for it, I'd just say a simple "If you have rust installed, follow this link to install mdBook, otherwise use this link"

I added to path and it took about a minute to do

GeckoEidechse commented 1 year ago

The code for book.toml is foreign to me, but I'd imagine it's for making mdBook work which I'm all for

Yup, exactly. I could add a comment into the book.toml file ^^

If we really wanted to have a section for it, I'd just say a simple "If you have rust installed, follow this link to install mdBook, otherwise use this link"

Good find, I'll add it \^\^