JuliaDocs/Documenter.jl

Option to apply custom CSS class to at-example blocks

Open

#2,208 opened on Aug 14, 2023

View on 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.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with Documenter.jlBasic HTML/CSS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.
Option to apply custom CSS class to at-example blocks · JuliaDocs/Documenter.jl#2208 | Good First Issue