@catnose99/micromark-minimal-extensions
v1.0.0
Published
最小構成の micromark 拡張セットです。HTTPS から始まる URL の自動リンク化と、パイプ区切りのテーブル構文(整列指定付き)のみをサポートします。
Downloads
17
Readme
micromark-minimal-extensions
最小構成の micromark 拡張セットです。HTTPS から始まる URL の自動リンク化と、パイプ区切りのテーブル構文(整列指定付き)のみをサポートします。
インストール
pnpm add micromark-minimal-extensionsこのパッケージは micromark と micromark-util-* 系の軽量ユーティリティに依存します。
使い方
import { micromark } from 'micromark'
import { minimalGfm } from 'micromark-minimal-extensions'
const markdown = `| Link |\n| :--- |\n| https://example.com |`
const html = micromark(markdown, minimalGfm())
console.log(html)
// =>
// <table>
// <thead>
// <tr>
// <th align="left">Link</th>
// </tr>
// </thead>
// <tbody>
// <tr>
// <td align="left"><a href="https://example.com">https://example.com</a></td>
// </tr>
// </tbody>
// </table>個別利用
import { micromark } from 'micromark'
import {
httpsAutolink,
httpsAutolinkHtml,
simpleTable,
simpleTableHtml
} from 'micromark-minimal-extensions'
const html = micromark(source, {
extensions: [httpsAutolink(), simpleTable()],
htmlExtensions: [httpsAutolinkHtml(), simpleTableHtml()]
})サポート仕様
- URL:
https://で始まる文字列のみを自動リンク化します。http://、mailto:、裸のドメインなどは対象外です。
- テーブル: ヘッダ行・区切り行・ボディ行のシンプルな GFM 互換記法。
- 左右中央揃え(
:---,---:,:---:)に対応。
- 左右中央揃え(
- Markdown → HTML 変換での利用を想定しています。
テスト
pnpm testnode:test で autolink/table の振る舞いを E2E 検証しています。
Publish
pnpm test
pnpm version <patch|minor|major>
pnpm publish --access publicpnpm versionでバージョン番号とタグを更新し、自動で Git タグが作成されます。- 公開前に
npm whoamiなどでログイン状態を確認してください。 - パッケージ名がスコープ付きの場合は
--access publicを付与します。
