-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use custom-block for docstrings #175
Conversation
Thanks for the PR! This looks promising. https://tpoisot.github.io/DocumenterVitepress.jl/dev/api has some examples of what this looks like now. From a brief look it seems that font sizes are smaller in the docstring block than in regular text? |
Would it be possible to mimic the Documenter.jl style for the docstrings here? We can leave out the collapsible and such. The border was added because DocumenterMarkdown used to generate continuous blocks of docstrings for mkdocs (making it hard to distinguish 2 separate docstrings, except the # marker) which was a constant source of complaint from users. |
|
Thanks all -- I think collapsible (open by default) is definitely achievable, I'm working on it Font size: this is how |
You could add new styles as in here https://github.com/JuliaDataCubes/YAXArrays.jl/blob/master/docs%2Fsrc%2F.vitepress%2Ftheme%2Fstyle.css#L259 |
yup - that's what I'm trying to do but without success so far... |
I get it... for some reason it's pulling the |
Maybe it's pulling it from docs/src/.vitepress since there's already a style.css there... |
well... it looks great as it is. Except, we have a huge empty space when collapsed. |
This makes sure that the DV docs always use the template CSS. Not sure if we want this but can always revert.
I think that's done? |
Any particular reason to revert the badge (9b637a4)? Personally it looked nicer compared to the dash |
Oh, yeah, I merged thinking the bubble badges were there. We should bring them back. |
They messed with the spacing a little, but I can try to adjust the margins and bring them back! |
The current styling for docstrings isn't really in line with the rest of the vitepress theme - this is a work in progress PR to use
class='jldocstring custom-block'
on the div, to make it look more native.