JuliaDocs/Documenter.jl

Option to apply custom CSS class to at-example blocks

Open

#2208 aperta il 14 ago 2023

Vedi su GitHub
 (0 commenti) (2 reazioni) (0 assegnatari)Julia (513 fork)batch import
Format: HTMLType: Enhancementhelp wanted

Metriche repository

Star
 (910 star)
Metriche merge PR
 (Merge medio 16g 9h) (3 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina l'implementazione esistente del blocco di esempio in Documenter.jl, in particolare nel sorgente HTMLWriter. Il PR referenziato in SpeedyWeather.jl (#345) mostra un approccio simile con classi CSS personalizzate. L'implementazione prevede l'analisi di un argomento opzionale di parola chiave nella macro @example e l'aggiunta della classe all'HTML generato in HTMLWriter. Non ci sono commenti o PR su questo problema, quindi l'approccio è aperto.
Tech stack
htmlcss
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JuliaGitHTMLCSS
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75