Markdown のプレビュー
左のファイルのプレビューで .md・.markdown・.mdx のファイルを開くと、既定で整形したプレビューで出ます。README や設計書を、コードと同じ画面で読めます。
プレビューとソース
Section titled “プレビューとソース”- 見出しの「プレビュー|ソース」で切り替えます。ソースはふつうのコードのパネルで、行を選んでレビューの質問ができます
- 行の範囲やシンボルを指すアンカー(データの旅の歩・レビューの範囲)から開いたときは、ソースで出ます
| もの | 中身 |
|---|---|
| コードの塊 | 言語の札・コピーのボタン・色付け。長い行は横に送ります |
| Mermaid の図 | 図が画面に近づいたときに描きます。「図|ソース」で切り替えられ、書き間違いがあれば理由とソースを出します。明暗の切り替えにもついてきます |
| 数式 | $…$・$$…$$ を数式として描きます |
| GitHub の書き方 | 表・チェックリスト・脚注・取り消し線・自動リンク・注記(Note・Tip・Important・Warning・Caution) |
| 目次 | 見出しの飛び先と目次 |
| 画像とリンク | リポジトリの中の相対パスの画像(PNG・SVG など)とリンク。リポジトリの外を指すもの(../../../ など)は開きません |
同じ描き方は、キャンバスの下の詳しい説明の段とチャットにも効きます。チャットと解説では、金額の $ を数式にしません。
Markdown は解析の対象のリポジトリや外から来たものなので、描く前に無害化します。<script>・onerror のような属性・javascript: のリンク・図の中のスクリプトは動きません。外部の画像は読みません。
1 MB 級の長い文書でも、解析を裏で行い、区切りごとに描くので、画面は止まりません。