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.
Option to apply custom CSS class to at-example blocks · JuliaDocs/Documenter.jl#2208 | Good First Issue