JuliaDocs/Documenter.jl

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

Open

#2.315 geöffnet am 30. Okt. 2023

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

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
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.
clear
Voraussetzungen
Basic CSSFamiliarity with Documenter.jl's HTML output
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85
Research-Richtung
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.