https://github.com/anydown/maildown

https://github.com/anydown/maildown

Last synced: about 6 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/anydown/maildown
• Owner: anydown
• License: mit
• Created: 2017-05-01T09:06:45.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-07-24T02:26:27.000Z (over 6 years ago)
• Last Synced: 2024-04-23T17:25:10.526Z (7 months ago)
• Language: JavaScript
• Homepage: https://maildown-example.netlify.com/
• Size: 1.03 MB
• Stars: 123
• Watchers: 2
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# これは？

Markdown から日本企業っぽいメールに変換します。

[![dependencies Status](https://david-dm.org/anydown/maildown/status.svg)](https://david-dm.org/anydown/maildown)

[![npm version](https://badge.fury.io/js/%40anydown%2Fmaildown.svg)](https://badge.fury.io/js/%40anydown%2Fmaildown)

# Demo

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

![image](https://user-images.githubusercontent.com/3132889/43113200-59139640-8f34-11e8-8c5e-e3aa5326a572.png)

🤔

# NPM から利用する

`npm install @anydown/maildown`

```js

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   | １行の最大文字長 | 70         |

# Who uses maildown

 - [Markdown to Plain](https://chrome.google.com/webstore/detail/markdown-to-plain/kcfemfieficedfhplhkmlpeddpkgiaok) : Chrome拡張 by [@mtgto](https://github.com/mtgto)

 - [md2mail](https://marketplace.visualstudio.com/items?itemName=satopirka.md2mail) : VSCode拡張 by [@satopirka](https://github.com/satopirka)