hyogen-md

0.10.0

hyogen ブロック

hyogen-md の制御構文は HTML コメント内に書きます。Markdown プレビューでは表示されません。

通常形: @hg … @endhg

<!--
@hg
include ./components/description.md
@endhg
-->

ショートハンド: @@ … @@

@hg / @endhg等価です。短く書けます。

<!--@@
include ./components/description.md
@@-->

書き方のバリエーション

改行あり・同一行・minify 相当のいずれでも認識します。

<!--@hg
const title = "Hello"
@endhg-->
<!--@hg /* ブロックコメントなら同一行でも OK */ @endhg-->
<!--@@ /* ワンライナー */ @@-->

同一行にまとめる場合、// 行コメントは行末までがコメントになるため使えません。その場合は /* */ を使ってください。

コメント

@hg 内では JavaScript と同様のコメントが使えます。

<!--
@hg

// 行コメント

/* ブロックコメント */

@endhg
-->

コードフェンス内は無視

コードフェンス(```)内の hyogen ブロックは 無視されます。生テキストとして扱い、実行・展開しません。

出力時の扱い

デフォルトでは、レンダリング後の Markdown から hyogen コメントは 除去されます。デバッグ用に残す場合は preserveHgComments: true を指定します。

二層モデル

領域内容
hyogen ブロック内宣言・代入・includeif / each の構造ディレクティブなど
&#123;&#123; &#125;&#125;式のみ

関連