search

LuxDL / DocumenterVitepress.jl

Documentation with Documenter.jl and VitePress
https://luxdl.github.io/DocumenterVitepress.jl/
MIT License
62 stars 9 forks source link

[DOCS] Tutorial for LiveServer usage #165

Closed TheCedarPrince closed 2 days ago

TheCedarPrince commented 4 days ago

This introduces a tutorial to complement #164 based on a long work session with @asinghvi17 .

@asinghvi17 , for deployments, will the creator need to remove these tweaks from their make.jl file? Or can these tweaks be safely left in when deployed? I wasn't sure if they could be left in or not.

Otherwise, feel free to make additional tweaks here as needed!

asinghvi17 commented 4 days ago

For deployment you would need to remove all tweaks, maybe we can make a convenience function to do this for you though (something like MarkdownVitepress(...) |> live_serveable maybe.

TheCedarPrince commented 3 days ago

That sounds great @asinghvi17 -- do we want to make that functionality now and then merge these two PRs or go ahead and merge the tutorial + your functionality that you just added and make this live_serveable function later? :thinking:

TheCedarPrince commented 2 days ago

Added this in @asinghvi17 !

TheCedarPrince commented 2 days ago

Right back at ya @asinghvi17