JuliaDocs/Documenter.jl

Option to apply custom CSS class to at-example blocks

Ouverte

#2 208 ouverte le 14 août 2023

Voir sur GitHub
 (0 commentaire) (2 réactions) (0 personne assignée)Julia (513 forks)batch import
Format: HTMLType: Enhancementhelp wanted

Métriques du dépôt

Stars
 (910 étoiles)
Métriques de merge PR
 (Merge moyen 16j 9h) (3 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Examinez l'implémentation existante du bloc d'exemple dans Documenter.jl, en particulier dans le code source d'HTMLWriter. La PR référencée dans SpeedyWeather.jl (#345) montre une approche similaire de classe CSS personnalisée. L'implémentation implique l'analyse d'un argument de mot clé facultatif dans la macro @example et l'ajout de la classe au HTML généré dans HTMLWriter. Il n'y a pas de commentaires ou de PR sur ce problème, donc l'approche est ouverte.
Stack technique
htmlcss
Domaine
documentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JuliaGitHTMLCSS
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75