-
Notifications
You must be signed in to change notification settings - Fork 12
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
versioning, picker component #178
Conversation
Well, this is almost working, is EMPTY. What am I missing? @jkrumbiegel maybe is easy for you to spot the missing piece. |
@lazarusA the versions.js file is not present at the expected location, for Makie it is there https://docs.makie.org/versions.js Edit: Ah it's at https://luxdl.github.io/DocumenterVitepress.jl/versions.js so the prefix is missing and needs to be added |
@lazarusA I think you can use |
docs/src/.vitepress/config.mts
Outdated
head: [['link', { rel: 'icon', href: '/DocumenterVitepress.jl/dev/favicon.ico' }]], | ||
head: [ | ||
['link', { rel: 'icon', href: '/DocumenterVitepress.jl/dev/favicon.ico' }], | ||
['script', {src: '/versions.js'}], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@asinghvi17 not here? I think I just need to add base here, isn't?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes that should also work!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
doesn't base
also contain dev
or stable
? If so that would not be correct
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, that doesn't work. It populates the menu, but the links are wrong.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mmm, not sure how to propagate base to the Vue component. If I'm not too tired, I will check again later. It will be good to have this finally in the next release, which will be breaking either way. So, a big bump will also be needed. Someone that knows more about it, please commit the appropriate bump.
well, that last one worked. But, documenter is putting the wrong versions in the
it looks like that, but it should be |
I think it's standard behavior, the Edit: yup - see https://github.com/JuliaDocs/Documenter.jl/blob/master/src/html/HTMLWriter.jl#L1476 - there's only one doc per minor release, so this seems to be working as intended 🎉 |
What's weird is that the link https://luxdl.github.io/DocumenterVitepress.jl/v0.1/ looks like it 404s, but it actually correctly resolves to the symlinked v0.1.1. The javascript console shows an error saying "Hydration completed but contains mismatches". When I refresh the page I actually see the homepage for a split second before the 404 overrides it. So vitepress seems not to be able to deal with the different address for some reason? |
This seems relevant? vuejs/vitepress#4160 |
I'm re-working also the logic, so that local builds also work without errors. |
I tested this on DD, without any issues. Here, most likely something went wrong when creating the |
} | ||
|
||
const baseTemp = { | ||
base: 'REPLACE_ME_DOCUMENTER_VITEPRESS',// TODO: replace this in makedocs! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@asinghvi17 by the way, the way these strings are replaced makes the code unnecessarily ugly. Couldn't you give every bit its own name like REPLACE_ME_DOCUMENTER_VITEPRESS_FAVICON
? Then one could it splice in directly wherever needed without relying on the base:
thing being present.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could, it's not super complicated to do either. Will look into it today.
In the Lux repo, only |
yes, is not taking the custom domain, and in turn getting the right path for Edit: The culprit https://github.com/LuxDL/Lux.jl/blob/e23b1a73257ea7094e89f13d64b1cbd609d09c8b/docs/src/.vitepress/config.mts#L59 it should be just |
This fixed it. Should we make a comment about that in the docs? Thanks for taking a look at this |
Out of curiosity, what is the status of this? For my own project, shall I just copy it from https://lux.csail.mit.edu/dev/? |
No description provided.