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

Option for CDN-free builds #2159

Open
mortenpi opened this issue Jun 29, 2023 · 2 comments
Open

Option for CDN-free builds #2159

mortenpi opened this issue Jun 29, 2023 · 2 comments
Labels
Format: HTML Related to the default HTML output help wanted Type: Enhancement

Comments

@mortenpi
Copy link
Member

The generated HTML/JS/CSS from the documentation builds depend on cdnjs and Google Fonts right now. It might be useful in some cases to build the docs without CDN-ed dependencies.

Something also worth considering is that we are kinda vulnerable to a CDN going offline or becoming inaccessible right now. So we could also consider bundling by default.

@mortenpi mortenpi added Type: Enhancement help wanted Format: HTML Related to the default HTML output labels Jun 29, 2023
@TheStarAlight
Copy link

Couldn't agree more. I usually work under an unstable network, and the equations and fonts usually load very slowly :(
I think the LocalHTML is a better plan because it not only gets rid of online resources but also ensures that the page looks the same as the version it is built.

@exaexa
Copy link

exaexa commented Jan 6, 2024

Hi, thanks for opening this. I think I'll need that feature too. :]

Some extra reasons why bundling the javascripts together with the doc would be marvelous:

  • Serving documentation that links to CDNs may require a GDPR banner in EU. This problem might get softened a bit by at least using the proper referrer policy in the generated HTML, there's currently none. (IANAL tho.)
  • Deployment of non-public (e.g., company-local) documentation doesn't leak user access stats and internal referer URLs
  • people who like to block javascripts don't need to unblock the whole cloudflare in order to get the doc search running

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Format: HTML Related to the default HTML output help wanted Type: Enhancement
Projects
None yet
Development

No branches or pull requests

3 participants