JuliaDocs/Documenter.jl

Option for CDN-free builds

Ouverte

#2 159 ouverte le 29 juin 2023

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

Métriques du dépôt

Stars
 (910 étoiles)
Métriques de merge PR
 (Merge moyen 16j 9h) (3 PRs mergées en 30 j)

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

Direction de recherche
Étudiez le pipeline de construction de Documenter.jl, probablement dans le module de génération HTML, pour comprendre comment les ressources CDN sont incluses. Recherchez les options de configuration existantes et envisagez d'ajouter un nouveau drapeau ou une nouvelle étape de construction pour regrouper les ressources localement ou omettre les dépendances externes. Consultez les commentaires sur l'issue pour obtenir un contexte supplémentaire.
Stack technique
javascriptcss
Domaine
tooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JuliaGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75