JuliaDocs/Documenter.jl

Option to apply custom CSS class to at-example blocks

Aberta

#2.208 aberto em 14 de ago. de 2023

Ver no GitHub
 (0 comentário) (2 reações) (0 responsável)Julia (513 forks)batch import
Format: HTMLType: Enhancementhelp wanted

Métricas do repositório

Stars
 (910 estrelas)
Métricas de merge de PR
 (Mesclagem média 16d 9h) (3 fundiu PRs em 30d)

Description

This is so that you could apply custom CSS styling if you want (e.g. https://github.com/SpeedyWeather/SpeedyWeather.jl/pull/345). I think it could look something like this:

```@example foo; html_class = "my-css-override"

And then HTMLWriter just adds the class to the DOM. The user can then add custom CSS to their docs build to style it.

Implementation is very much up for grabs though.

Guia do colaborador

Direção de pesquisa
Examine a implementação existente do bloco de exemplo em Documenter.jl, particularmente no código fonte do HTMLWriter. O PR referenciado em SpeedyWeather.jl (#345) mostra uma abordagem semelhante de classe CSS personalizada. A implementação envolve analisar um argumento de palavra chave opcional na macro @example e adicionar a classe ao HTML gerado no HTMLWriter. Não há comentários ou PRs sobre este problema, portanto a abordagem está aberta.
Pilha de tecnologia
htmlcss
Domain
documentation
Tipo Issue
Funcionalidade
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.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JuliaGitHTMLCSS
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75