mdmark

雛形を置く

mdmark init で設定・theme.css・索引・拡張のビルドの雛形を置く手順

書き出しに使う設定と索引と使う側の CSS を、フォルダに初めて用意するときに実行する。

前提

• Node 24 以降

手順

雛形を置く

init を呼ぶ

npx github:shuhei1101/mdmark#v{版} init [{置く先のフォルダ}]

{版} は使う版の {MAJOR}.{MINOR}.{PATCH}。 版は 変更履歴。 置く先のフォルダを省くと今のフォルダに置く。 置く先のフォルダが無ければ作る。

次のファイルを、この順に置く。

• mdmark.config.yaml: version・index・theme・build を書いた設定
• theme.css: CSS 変数を上書きする例
• index.yaml: 文書と用語が 0 件の索引
• extensions/example.ts: registerExtension に渡す拡張を既定の export にする例
• tsconfig.json・package.json: 拡張の型の検査と JavaScript への変換のコマンド

置いたファイルごとに 1 行ずつ出る。

置いた: mdmark.config.yaml
置いた: theme.css
置いた: index.yaml
置いた: extensions/example.ts
置いた: tsconfig.json
置いた: package.json

置いた設定の version は、呼んだ CLI の版。 手元の版として、mdmark upgrade が読む（版を上げる）。 置いた設定と索引は、schemas/mdmark.config.schema.json と schemas/mdmark.index.schema.json に合う。

既にあるファイルを残す

既にあるファイルは、中身を読まず上書きしない。 置かなかったファイルは 置かなかった（既にある）: の行で出る。

置かなかった（既にある）: mdmark.config.yaml
置いた: theme.css

JavaScript で書くときは --js を付ける

npx github:shuhei1101/mdmark#v{版} init --js

extensions/example.ts の代わりに extensions/example.js を置き、package.json は置かない。 extensions/example.js は先頭に // @ts-check を置き、JSDoc の @type で MdmarkExtension の型を付けた例。 置く tsconfig.json は JavaScript を変換せずに点検する（allowJs・checkJs・noEmit）。 使う版の dist/index.d.ts を mdmark/ に置いて npx tsc --noEmit を流すと、型を誤った行がファイルと行つきで出る（固有の部品とCSSを当てる）。

書けないとき

置く先のフォルダを作れないときと、ファイルを書けないときは、標準エラーに書けなかったパスと直し方の 1 文を出し、終了コード 1 で終わる。 それまでに書けたファイルは残る。

反映

即時。init が終わると、ファイルがその場に置かれている。

確認

雛形が置かれている

置いた: の行が出て、init の終了コードが 0 になる。 置かなかったファイルがあっても、終了コードは 0 になる。 文書を足した後の点検は 点検する。

元に戻す

置いたファイルを消す。 置かなかったファイルは init が変えていないため、戻すものは無い。