JuliaDocs/Documenter.jl

Option to apply custom CSS class to at-example blocks

Open

#2,208 opened on 2023年8月14日

GitHub で見る
 (0 comments) (2 reactions) (0 assignees)Julia (910 stars) (513 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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