pantoken-root / plugins/typedoc/demo/src / rewriteComment

関数: rewriteComment() ​

rewriteComment(comment): void

ベータ

コメント上のすべての @demo ブロックタグを順番に、その要約に追加された demo フェンスに移動します。 ブロックタグの内容はマークダウンテーマによって再フェンスされるため、フェンスは要約の本文内に存在する必要があり、本文は逐語的に出力されます。

パラメーター ​

comment ​

Comment

書き換える対象のコメント。

戻り値 ​

void

例 ​

ts
import { rewriteComment } from "@pantoken/typedoc-plugin-demo";

// Given a comment with `@demo self:button`, appends a ```demo``` fence and drops the tag.
rewriteComment(comment);