HTML format: offline_version parameter #2532
Conversation
|
Broadly, I think this looks pretty good, and it would be great to have this option. Thank you for taking a stab at this! One thing that stands out to me is that we're modifying all the signatures for the different libraries in |
src/html/RD.jl
Outdated
| function _process_downloaded_css(file_content, origin_url) | ||
| url_regex = r"url\(([^)]+)\)" | ||
| replace(file_content, url_regex => s -> begin | ||
| rel_url = match(url_regex, s).captures[1] | ||
| url = normpath(dirname(origin_url), rel_url) | ||
| font_type = font_ext_to_type[splitext(rel_url)[end]] | ||
| encoded_file = Base64.base64encode(_download_file_content(url)) | ||
| return "url(data:font/$(font_type);charset=utf-8;base64,$(encoded_file))" | ||
| end) | ||
| end |
There was a problem hiding this comment.
This is a bit non-trivial. It would be good to have a comment for it.
src/html/RD.jl
Outdated
| @error "offline_version requires curl." | ||
| error() |
There was a problem hiding this comment.
| @error "offline_version requires curl." | |
| error() | |
| error("offline_version requires curl.") |
src/html/RD.jl
Outdated
| _process(dep::RemoteLibrary, build_path, origin_path) = RemoteLibrary(dep.name, _process(dep.url, build_path, origin_path); deps = dep.deps, exports = dep.exports) | ||
|
|
||
| function _download_file_content(url::AbstractString) | ||
| cmd = `curl $url -s --output -` |
There was a problem hiding this comment.
Could also use Downloads.jl here. But curl is what we use elsewhere right now, and while we want to move away from it (#2254), its also completely fine to keep it as is.
Thank you! I tried applying your comments. I basically added some comments, and used Downloads.jl instead of
I agree it's not nice to have to change these signatures and tried avoiding that. At some point I was indeed using JSDependencies but the thing is that all these functions in RD.jl actually convey a lot of information to JSDependencies when constructing the RemoteLibraries. And they need that build_path/output_path at this moment. I'd be happy to improve this part of the code but I don't see how yet, without modifying the whole RD.jl file, changing completely how it interacts with JSDependencies. Happy to hear a more specific idea on this if you have it. |
Adresses JuliaLang/julia#19354 and one of the items on #212.
The general idea is to try to add a keyword parameter to the
HTML()struct. By puttingformat = Documenter.HTML(offline_version = true)in the parameters ofmakedocs, the HTML output should come bundled with all the CDNs.Here is a list of what I've done:
process_remote. This function, depending on the user-given parameter will download the dependency using curl and write it in the right file, replacing the CDN url with a relative URL._process_downloaded_css(with a regex)I might have missed some dependencies or could improve some of the functions signature, would gladly take some feedback!