mdmark export で 1 文書を 1 枚の HTML に書き出す手順
Markdown を 1 つ、CDN を読まずに file:// で開ける HTML にして配るときに実行する。
mdmark.config.yaml を今のフォルダか上のフォルダに置いている)libraries の URL の先へ届くsyntax.url の先へ届くexport を呼ぶnpx github:shuhei1101/mdmark#v{版} export {文書} [--out {出力}] [--config {設定ファイル}]
{文書} は書き出す Markdown のパス。
--out を省くと、文書と同じフォルダに、拡張子を .html に替えたパスで書く。
出力の親のフォルダが無ければ作り、出力が既にあれば上書きする。
--config を省くと、今のフォルダから上のフォルダへ順に mdmark.config.yaml を探す。
書き出した: docs/使い方/guide.html
書き出した HTML には、次のものが埋まる。
theme の CSS(配布物の CSS の後)libraries の URL から読み、モジュールが import する先も束ねる)syntax.url から読む。使わない言語は埋めない)extensions の拡張のモジュールdata: URL に替える)index があるとき、索引と参照の表相対パスの libraries と syntax.url の URL は設定ファイルのあるフォルダを、画像は文書のフォルダを基準に読む。
設定の features.syntax をオフにしたときと、文書の <!-- features: -syntax --> があるときは、色分けを埋めない。
文書に書いたスクリプトは実行されない。
文書間のリンクは書いたままの href で残る。
文書を行き来させたいときは 文書を1枚にまとめる。
読めないものは、書き出しを止めず標準エラーに 1 つ 1 行で出す。 警告があっても終了コードは 0 で、読めたものだけを埋めて書く。
警告: docs/使い方/guide.md: 画像 `img/missing.png` を読めません。パスを直すか画像を置いてください。
警告の対象は、読めない画像・外部ライブラリのモジュール・色分けの本体と言語のモジュール・拡張・theme の CSS と、埋めずに残した絶対 URL の画像。
絶対 URL の画像は、開いたときに外へ要求する。
読めない外部ライブラリの印の場所には、開いたとき知らせの枠が出る。
色分けの本体を埋められなかったときは全てのコードブロックが、言語のモジュールを埋められなかったときはその言語のコードブロックが、開いたとき色分けされずに書いたとおりに出る。
設定ファイルが無い・読めない・Schema に合わないとき、{文書} を読めないとき、出力先へ書けないときは、原因と直し方の 1 文を標準エラーに出し、終了コード 1 で終わる。
HTML はどこにも書かない。
設定が Schema に合わないときは、点検する でどこが合わないかを確かめる。
書き出した HTML 1 つを、配る先へ写して開く。
開いてから描き終えるまで、ページ自身と blob:・data: のほかへ要求しない。
開くブラウザは Chrome 99・Firefox 98・Safari 16.4 以上。
即時。export が終わると、出力に HTML が書かれている。
出力のパスに HTML があり、標準出力に 書き出した: の行が出て、終了コードが 0 になる。
HTML だけを空のフォルダへ写して file:// で開く。
文書が描かれ、表の並べ替えや用語のツールチップなどの操作が効く。
言語を書いたコードブロックは色分けされている。
ブラウザの開発者ツールのネットワークに、ページ自身と blob:・data: のほかの要求が出ない。
書き出した HTML を消す。
文書・設定・索引は export が書き換えない。