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 (910 stars) (513 forks)batch import
Format: HTMLType: Enhancementhelp wanted

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

Tech stack
css
Domain
documentationdesign
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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic CSSFamiliarity with Documenter.jl's HTML output
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Investigate the Documenter.jl source code for the CSS styles that render compatibility callouts (e.g., styles for `.admonition.compat` or similar classes). The issue references a PR in JuliaLang/julia#46717, which may provide context. The goal is to make the callout more subtle—likely by adding a new CSS class or modifying existing styles to use lighter colors, smaller font, or italics. Look at the theme files in `src/` or `assets/` for styling definitions.