JuliaDocs/Documenter.jl

Option for CDN-free builds

Open

#2.159 geöffnet am 29. Juni 2023

Auf GitHub ansehen
 (2 Kommentare) (7 Reaktionen) (0 zugewiesene Personen)Julia (910 Stars) (513 Forks)batch import
Format: HTMLType: Enhancementhelp wanted

Beschreibung

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.

Contributor Guide

Tech Stack
Keine
Domain
documentation
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Familiarity with Documenter.jlBasic Julia knowledge
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
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.