/maildown

Markdown to Plain Text

Primary LanguageJavaScriptMIT LicenseMIT

これは?

Markdown から日本企業っぽいメールプレーンテキストで読みやすいテキストに変換します。

dependencies Status

npm version

Demo

https://maildown-example.netlify.com/

image

🤔

NPM から利用する

npm install @anydown/maildown

const maildown = require("@anydown/maildown");

const converted = maildown(`## test

# test

- this
- is
- test
`, {lineLength: 70});

console.log(converted);
//>  ■test
//>  【test】
//>   ・this
//>   ・is
//>   ・test

Options

オプション名 説明 デフォルト
lineLength 1行の最大文字長 70
h1PrefixText h1 の接頭辞テキスト
h1SuffixText h1 の接尾辞テキスト
h2PrefixText h2 の接頭辞テキスト
h2SuffixText h2 の接尾辞テキスト ``
h3PrefixText h3 の接頭辞テキスト
h3SuffixText h3 の接尾辞テキスト ``
h4PrefixText h4 以降の接頭辞テキスト
h4SuffixText h4 以降の接尾辞テキスト ``
listDefaultSpacer リストの左端に挿入するスペーサー ``
listAdditionalSpacer リストに追加するスペーサー
listPrefixText リストの接頭辞テキスト
listPrefixNumbering リスト接頭辞テキスト(ナンバリング) (%d)

Who uses maildown