Giter VIP home page Giter VIP logo

mm's Introduction

markdown-mailer

npm

Markdown-mailer is a cli tool written in Javascript to send your mail written in markdown. It's based on some popular JS packages such as showdown and nodemailer. After you finished the config process, you can send your markdown just with a simple mm send <markdown-path> command.

Installation

npm

npm install -g markdown-mailer

yarn

yarn global add markdown-mailer

Usage

config

Before you can use markdown-mailer to send email, you must set up it with some basic information such as which smtp service you want to use, the from and to address, etc. Run mm config -h to see the full options you can use with markdown-mailer as follows:

Usage: config [options]

Config mm

Options:
  -l, --list                 list the current configuration
  -s, --service <service>    config the SMTP service you will use to send your email
  -f, --from <from>          config the from address
  -t, --to <to...>           config the to addresses, multi addresses should be seperated by commas
  -b, --subject <subject>    config the subject
  -p, --password <password>  config password. Note it is the app specific password not the account password. For example if you are using gmail service, you can check this link for help: https://support.google.com/accounts/answer/185833?hl=en
  -h, --help                 output usage information

Use mm init to initialize the configuration, or use mm config to update it.

send

Use mm send <markdown-path> to send the specified markdown mail.

help

Use mm -h to see more detailed information

Samples

Given the following markdown file:

# 项目
* 背景:****
* 项目成员:****
* 计划(一期)

    * 文本
* 本周工作
    
    1. 任务1

            yarn global add markdown-mailer
    1. 文本 ```代码``` 
    1. 列表
        
        * 文本
        * 文本

# 日常

1. 文本
2. 文本


# 下周计划

1. 文本
1. 文本

then run:

mm send test.md

you will receive the following like mail: mac-mail

mm's People

Contributors

dependabot[bot] avatar xueminghao avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.