Using VitePress for documentation #808
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #808 +/- ##
=======================================
Coverage 97.33% 97.33%
=======================================
Files 36 36
Lines 3495 3495
=======================================
Hits 3402 3402
Misses 93 93
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
I think this doc is now good to go! |
|
is it possible to deploy this only for the dev version to elicit feedback, or deploy an experimental version without taking down the current documentation? |
ajinkya-k
changed the title
|
@palday was that merge commit because there was some merge conflict? The only thing that seems to have changed is the header id, but the final output looks same as the commit before that |
|
@palday what else needs to be done for this to be merged? |
|
I updated the preview doc, take a look: https://ajinkya-k.github.io/MixedModels.jl/api |
| format = DocumenterVitepress.MarkdownVitepress( | ||
| repo = "https://github.com/JuliaStats/MixedModels.jl", | ||
| ), | ||
| clean = true | ||
| ) | ||
|
|
||
| deploydocs(; |
There was a problem hiding this comment.
This needs to be DocumenterVitepress.deploydocs in DV v0.2
This is a speculative draft PR. I think
VitePressbased docs look much better than the default julia-docs style. While mostly an aesthetic choice, one particular issue with the current docs style is the default fonts chosen byDocumenter.jlrender very poorly for me when using an external monitor with a Mac. So I recreated the documentation for this package usingDocumenterVitepress.jland it's deployed for preview at: https://ajinkya-k.github.io/MixedModels.jl/ . I cant setup CI so I manually cobbled together the rendered files on thegh-pagesbranch. There are still quite a few kinks to work out but I think it looks great! See for example the Model constructors page for a well rendered page: https://ajinkya-k.github.io/MixedModels.jl/constructorsLet me know what you all think!