JuliaDocs/Documenter.jl

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

Open

#2 315 ouverte le 30 oct. 2023

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)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

Guide contributeur

Stack technique
css
Domaine
documentationdesign
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic CSSFamiliarity with Documenter.jl's HTML output
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85
Direction de recherche
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.