JuliaDocs/Documenter.jl

feature request: support `compat` with more subtle callout format

Open

#2,315 opened on Oct 30, 2023

View on GitHub
 (1 comment) (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

When adding !!! compat "Julia 1.6" blocks, these render quite boldly in the docs, while it seems like they could be a more subtle callout in some variation of light gray, smaller, and/or italics: image

Compare to say sphinx, where it is rendered with a more subtle italics: image http://docs.libuv.org/en/v1.x/misc.html

Refs: https://github.com/JuliaLang/julia/pull/46717/files

Contributor guide

Research direction
Investigate how to customize the style of compat callout boxes in Documenter.jl by modifying CSS or using custom themes; look for existing customization options in Documenter.jl's documentation.
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.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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
CSSJulia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85