stapy120

MyST記法のルール。(1) パイプテーブルではなくlist-tableディレクティブを使用する。(2) 太字見出し＋箇条書きの複数グループはlist-tableに変換する。(3) コードブロックは外部ファイルからliteralincludeで取り込む。(4) フロー図はmermaidディレクティブで記述する。(5) 注意喚起はAdmonitionディレクティブを使用する。(6) 用語説明は定義リストで記述する。MyST/Sphinxのマークダウンを生成するときに適用する。

sphinx-revealjsの設定ルール。(1) Reveal.jsプラグインはUMDバンドル版を使用する。(2) ハイライトにはCSSテーマの読み込みが必須。(3) スライド幅はrevealjs_script_confで調整する。(4) Mermaidダイアグラムはsphinx-oceanidによるクライアントサイド遅延レンダリング。(5) スライドの左右分割にはlist-tableを使用する。sphinx-revealjsのconf.pyやスライドを編集するときに適用する。

日本語のスライドを書く際のルール。Reveal.jsスライドのマークダウンを生成するときに適用する。