JuliaDocs/Documenter.jl

Option for CDN-free builds

Open

#2,159 opened on Jun 29, 2023

View on GitHub
 (2 comments) (7 reactions) (0 assignees)Julia (513 forks)batch import
Format: HTMLType: Enhancementhelp wanted

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (Avg merge 16d 9h) (3 merged PRs in 30d)

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.

Contributor guide

Research direction
Examine the build process for Documenter.jl to understand how CDN dependencies are included. Then implement a configuration option to either exclude CDN resources or bundle them locally.
Tech stack
javascriptcss
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JuliaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75