JuliaDocs/Documenter.jl

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

Open

#2.315 aberto em 30 de out. de 2023

Ver no 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

Guia do colaborador

Pilha de tecnologia
css
Domain
documentationdesign
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
under 1 hour
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
fresh
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Basic CSSFamiliarity with Documenter.jl's HTML output
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85
Direção de pesquisa
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.