mdgp

将 '.md' 文件转换为 .html, 并发布到 Github pages 上.

Example

Installation

$ npm install -g mdgp

Usage

• 在你的 git 仓库下执行该命令，将默认发布 README.md 文件:

  $ mdgp

• 指定要发布的 '.md' 文件：

  $ mdgp -f src/api.md

• 提示

  执行 mdgp 时会自动复制 md 文件所在目录下的 images 文件夹。

  因此，如果您的 md 文件需要引入一些图片，您可以在 md 文件所在目录下创建 images 文件夹，并将图片资源存放到该文件夹下

• 查看帮助

  Usage: mdgp [options]
  
  Options:
  
    -h, --help     output usage information
    -V, --version  output the version number
    -f, --file     specify the file.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

License

this repo is released under the MIT License.