JuliaDocs/Documenter.jl

Enable user to set default color scheme

Open

#1,573 opened on Apr 30, 2021

View on GitHub
 (5 comments) (0 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

I have to admit, while I think the PR https://github.com/JuliaDocs/Documenter.jl/pull/1456 is interesting and useful, I'm not sure it's a great idea by default. I think at least having an optional feature to override the default color-scheme would be beneficial.

For example, many documentation sites are not optimally set-up for dark-theme first (if the user has the OS set to a dark theme).

For example, take a look at https://jump.dev/JuMP.jl image

Similarly, the Makie docs look better with a light-default, as the animations and plots use a white background by default image

Contributor guide

Research direction
Examine the existing PR #1456 and the current color scheme implementation. Determine where default colors are set and how to allow user override via configuration.
Tech stack
julia
Domain
documentation
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.
65