PreviewMD Mac・iPad・iPhone 用
入手

PreviewMD が表示できるもの、そしてそれを表示しているもの

以下に挙げるレンダラーはすべてアプリの中に同梱されています。書類を描くあいだ何も取得せず、CDN にも接続せず、テレメトリが端末から出ていくこともありません。だからこそクイックルックは即座に現れ、そしてこれらすべてが飛行機の中でも動きます。

このページも同じ仕組みで表示されています。上のソースに切り替えれば、ここにあるどの例でも、その裏側の Markdown を見られます。

モジュール

モジュール バージョン 役割
markdown-it 14.1.0 パーサー。CommonMark と、下に挙げる GitHub 拡張
KaTeX 0.16.22 数式を、画像ではなく組版で
Mermaid 11.16.1 テキストから描かれる図
highlight.js 11.11.1 シンタックスハイライト、約 200 言語
@vscode/markdown-it-katex 1.1.2 本文の $…$ と $$…$$ を見つけて KaTeX に渡す
markdown-it-task-lists 2.1.0 - [x] のチェックボックス
markdown-it-footnote 4.0.0 脚注と、そこから戻るリンク
markdown-it-emoji 2.0.2 :shortcodes:
markdown-it-front-matter 0.2.4 YAML のフロントマター。表示せずに隠す
jsdiff + diff2html — 差分ビューと、その単語単位のハイライト
github-markdown-css — ページのスタイル、ライトとダーク

それぞれが自前のライセンス表示を持っていて、アプリのヘルプ ▸ 謝辞に原文のまま収めてあります。

数式

KaTeX は数式を組版するので、拡大しても粗くならず、テキストとして選択もコピーもできます。ぼやけた画像として届くことはありません。行内の数式はドル記号ひとつで囲みます。たとえば軌道上の任意の点における速度は v=μ(2/r−1/a)v = \sqrt{\mu(2/r - 1/a)} です。独立した行に置く数式はドル記号ふたつで囲みます。

Δv=μr1(2r2r1+r2−1)\Delta v = \sqrt{\frac{\mu}{r_1}}\left(\sqrt{\frac{2r_2}{r_1+r_2}} - 1\right)

行列、総和、整列した数式も同じように書けます。

A=(abcd)∑n=1∞1n2=π26A = \begin{pmatrix} a & b \\ c & d \end{pmatrix} \qquad \sum_{n=1}^{\infty} \frac{1}{n^2} = \frac{\pi^2}{6}

図

mermaid と記した囲みブロックは、そのまま絵になります。正となるのはあくまでテキストです。1 行書き換えれば絵が変わり、それでもファイルはバージョン管理が差分を取れるテキストファイルのままです。

graph LR
  A[書く] --> B[プレビュー]
  B --> C{思ったとおり?}
  C -- はい --> D[書き出す]
  C -- いいえ --> A

やり取りのあるものには、シーケンス図です。

sequenceDiagram
  participant F as Finder
  participant Q as クイックルック
  participant P as PreviewMD
  F->>Q: README.md でスペースキー
  Q->>P: このファイルを表示して
  P-->>Q: 整形されたページ
  Q-->>F: 表示完了、アプリは起動せず

そして、表にすると自分で計算させられてしまう割合には、円グラフです。

pie showData
  title README の中身
  "文章" : 55
  "コードブロック" : 30
  "表" : 10
  "図" : 5

状態遷移図、クラス図、ガントチャート、そのほか Mermaid の持ち札も同じように表示されます。

コード

囲みブロックは highlight.js がハイライトします。約 200 言語を知っています。言語名は開始の囲みのあとに書きます。

struct Entry: Comparable {
    let clock: UInt64
    let device: UUID

    static func < (a: Entry, b: Entry) -> Bool {
        // 同着はデバイス ID で決めるので、順序はどこでも同じになる。
        (a.clock, a.device.uuidString) < (b.clock, b.device.uuidString)
    }
}
def hohmann(r1: float, r2: float, mu: float = 3.986e14) -> float:
    """円軌道間の遷移に必要な合計デルタ V。"""
    first = (mu / r1) ** 0.5 * ((2 * r2 / (r1 + r2)) ** 0.5 - 1)
    second = (mu / r2) ** 0.5 * (1 - (2 * r1 / (r1 + r2)) ** 0.5)
    return first + second

言語を指定しないブロックはそのまま等幅のテキストとして残り、inline code には言語の指定は要りません。

GitHub の拡張

GitHub が Markdown に加えたもの、つまり README がそこにあるものとして書かれているものです。

  • タスクリスト、チェックボックス付きで
  • まだ終わっていないものも含めて
  • 当てはまらなくなったものには 打ち消し線
  • 脚注[1]、番号付きで戻るリンクも
  • 自動リンク:https://previewmd.xfanta.com はそれだけでリンクになります
  • ショートコードによる絵文字:🚀 ✨ ✅

Note

アラートは GitHub 独自の慣習で、Markdown のどの仕様にも 含まれていません。最初の行で種類を示す引用ブロックです。

Warning

種類は 5 つです。Note、Tip、Important、Warning、Caution。


  1. 書類の末尾に置かれ、読んでいた場所へ戻る矢印が付きます。 ↩︎

目立たないもの

フロントマター。 ファイルの冒頭、--- の行に挟まれた YAML のブロックは静的サイトジェネレーター向けのメタデータで、読ませるつもりで書かれたものではありません。意味不明な表として印字するのではなく、解析して隠します。

画像。 書類が参照しているローカルの画像は、その書類が置かれているフォルダから読み込んで表示します。ネットワーク越しには何も取得しないので、パスの切れた書類は固まるのではなく、そう表示します。

表。 ふつうの GFM のパイプ表で、揃えは区切り行のコロンから読み取ります。幅の広い表は、ページを崩すのではなくスクロールします。

これらすべてを、お使いの Mac で読む

PreviewMD はこのページにあるものすべてを、クイックルックでも、専用のウィンドウでも、書き出した HTML と PDF でも表示します。Mac、iPad、iPhone で無料です。

チートシートにはすべての記号とその結果が並んでいますし、Markdown とは何かではこの形式がどこから来たのかを扱っています。