Skip to content
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

Avoid online dependencies for bundled HTML documentation #19354

Open
julia-issue-2016-11-17 opened this issue Nov 17, 2016 · 2 comments
Open
Assignees
Labels
docsystem The documentation building system

Comments

@julia-issue-2016-11-17
Copy link

I appreciate Julia's bundled, offline HTML documentation. However, it currently references several remote resources, causing it to load slowly when the internet connection is slow or absent. I found that removing references to fonts.googleapis.com and the modernizr script on cloudflare fixes the problem. The offline documentation should come bundled with copies of all of its JS libraries; it already does so for jquery and underscore. Thanks.

@kshyatt kshyatt added the docsystem The documentation building system label Nov 17, 2016
@KristofferC
Copy link
Member

What is the status of this @mortenpi

@mortenpi
Copy link
Contributor

mortenpi commented Jun 25, 2017

Somewhere on the TODO list in principle (JuliaDocs/Documenter.jl#212). Offline docs definitely shouldn't depend on CDNs, but it has been low-priority.

Wouldn't be too hard to do -- just needs a new format or option. We'd need to download the .js files during the build. Updating the <link> tags would be easy, but we'd also generate documenter.js dynamically since that contains the links to the js libraries. The tricky bit would be to deal with the libraries that load additional resources (e.g. MathJax and the fonts).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docsystem The documentation building system
Projects
None yet
Development

No branches or pull requests

5 participants