search

JuliaDocs / Documenter.jl

A documentation generator for Julia.
https://documenter.juliadocs.org
MIT License
799 stars 474 forks source link

Generated files with Documenter.jl and julia-docdeploy have random characters included in their name, not rendering correctly #2536

Closed brian-dellabetta closed 1 week ago

brian-dellabetta commented 1 week ago

I'm not sure if this is an issue for Documenter.jl, DocumenterVitepress.jl or julia-docdeploy, but things run fine locally with npm, using the steps outlined here.

I have a publicly accessible repo using Documenter.jl (see make.jl here) and the julia-docdeploy github action here. The github actions are successful and the gh-pages branch is updated, but random string segments get injected into the static files generated by Documenter. For example, I create a lorenz.mp4 asset inside my Documenter example here, but the gh-pages branch has a file lorenz.C1w-s6U0.mp4. A similar thing happens with style.css.

Because of this my page loads (https://brian-dellabetta.github.io/Fusion.jl/dev/) but the static elements can't be found (no video, no fonts, no styling). Any idea what I'm doing wrong here? I might just have some configuration incorrect. I won't update any of those links I posted above until this is resolved.

brian-dellabetta commented 1 week ago

https://github.com/julia-actions/julia-docdeploy/issues/37

mortenpi commented 1 week ago

This seems to be DocumenterVitepress-related. I strongly suspect this is just how Vitepress works -- that looks like the somewhat standard way of handling caching issues, by randomizing the filenames of assets (which we don't do in Documenter right now, though it has been discussed). Not sure why the site would break though. cc @asinghvi17

I'll close this, since I don't think this is actionable here.

asinghvi17 commented 1 week ago

Yes, this looks like a DocumenterVitepress issue to me. Try using lorenz.mp4 instead of ./lorenz.mp4 and see if that helps? Vitepress uses Rollup which is pretty specific on file paths and what it considers valid.

Otherwise, you can try to include the video element via Markdown...

brian-dellabetta commented 6 days ago

Thanks @mortenpi and @asinghvi17 for the quick response. It ended up being a configuration issue in DocumenterVitepress as you suggested.

In case others have this issue, dropping deploy_url from DocumenterVitepress.MarkdownVitepress(... resolved it. Thanks @asinghvi17 for the PR