JuliaDocs/Documenter.jl

Option for CDN-free builds

Open

#2 159 ouverte le 29 juin 2023

Voir sur GitHub
 (2 commentaires) (7 réactions) (0 assignés)Julia (910 stars) (513 forks)batch import
Format: HTMLType: Enhancementhelp wanted

Description

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.

Guide contributeur

Stack technique
Aucun
Domaine
documentation
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
Familiarity with Documenter.jlBasic Julia knowledge
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
Investigate the Documenter.jl build pipeline, likely in the HTML generation module, to understand how CDN assets are included. Look for existing configuration options and consider adding a new flag or build step to either bundle assets locally or omit external dependencies. Review any comments on the issue for additional context.