JuliaDocs/Documenter.jl

Option to apply custom CSS class to at-example blocks

Offen

#2.208 geöffnet am 14.08.2023

Auf GitHub ansehen
 (0 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)Julia (513 Forks)batch import
Format: HTMLType: Enhancementhelp wanted

Repository-Metriken

Stars
 (910 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 16T 9h) (3 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Betrachten Sie die bestehende Beispielblock Implementierung in Documenter.jl, insbesondere im HTMLWriter Quellcode. Der referenzierte PR in SpeedyWeather.jl (#345) zeigt einen ähnlichen Ansatz mit benutzerdefinierten CSS Klassen. Die Implementierung umfasst das Parsen eines optionalen Schlüsselwortarguments im @example Makro und das Hinzufügen der Klasse zum generierten HTML in HTMLWriter. Es gibt keine Kommentare oder PRs zu diesem Issue, daher ist der Ansatz offen.
Tech Stack
htmlcss
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JuliaGitHTMLCSS
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75