FriesischScott / UncertaintyQuantification.jl

Uncertainty Quantification in Julia
MIT License
31 stars 11 forks source link

Pretty docs using Documenter Vitepress #221

Open AnderGray opened 1 week ago

AnderGray commented 1 week ago

It's quite easy to host the docs using JavaScript / node.js with DocumenterVitepress.jl.

You pretty much just need to change the format in docs/make.jl https://github.com/FriesischScott/UncertaintyQuantification.jl/blob/41a89ea33bfdfa7325136057a09bc8ada5bed474/docs/make.jl#L17

To something like:

format=DocumenterVitepress.MarkdownVitepress(repo = "https://github.com/FriesischScott/UncertaintyQuantification.jl", devbranch = "master",
    build_vitepress = false,
    md_output_path = "."),

Has some quite nice results: Screenshot 2024-09-27 at 14 22 42

Not sure how this changes the plans to publish a pdf manual. It also makes the locally compiling the docs slightly more involved. I think we can add an option to the docs build, one for the standard way (locally), and one with vitepress.