JuliaDocs/Documenter.jl

Option to apply custom CSS class to at-example blocks

Open

#2.208 aberto em 14 de ago. de 2023

Ver no GitHub
 (0 comments) (2 reactions) (0 assignees)Julia (910 stars) (513 forks)batch import
Format: HTMLType: Enhancementhelp wanted

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

Pilha de tecnologia
None
Domain
documentation
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.
1-3 hours
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.
mostly clear
Prerequisites
Familiarity with Documenter.jlBasic HTML/CSS
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70
Direção de pesquisa
Look at the existing example block implementation in Documenter.jl, particularly in the HTMLWriter source. The referenced PR in SpeedyWeather.jl (#345) shows a similar custom CSS class approach. The implementation involves parsing an optional keyword argument in the @example macro and adding the class to the generated HTML in HTMLWriter. There are no comments or PRs on this issue, so the approach is open.