Using VitePress for documentation #808
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 3488 3488
=======================================
Hits 3395 3395
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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!