JuliaDocs/Documenter.jl

Option to apply custom CSS class to at-example blocks

Open

#2,208 创建于 2023年8月14日

在 GitHub 查看
 (0 评论) (2 反应) (0 负责人)Julia (910 star) (513 fork)batch import
Format: HTMLType: Enhancementhelp wanted

描述

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.

贡献者指南

技术栈
无
领域
documentation
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Familiarity with Documenter.jlBasic HTML/CSS
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
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.