5 Star 3 Fork 0

Gitee 极速下载 / markdown2html-cli

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
此仓库是为了提升国内下载速度的镜像仓库,每日同步一次。 原始仓库: https://github.com/xbynet/markdown2html-cli
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

markdown2html-cli

Markdown to HTML use gulp ,support auto toc , syntax highlight.

How to use?

Move to the root dir of project, rename your md file to index.md, run:

npm install

then run:

gulp tohtml    

The generated file located in dist/index.html.

But, what if i want to real-time preview when i write markdown file?Don't worry. You can use gulp watch like below:
1、first you should install chrome ext named livereload
2、ordered run commandline:

$ cd your_work_dir
$ http-server    ;;;if your have not install it.please run   npm install -g http-server
$ gulp watch

Now you can open 127.0.0.1:8080/index.html to see it.

Cli args:

  • --path : the work filepath ,it support gulp path syntax like *.md,**/*.md,etc.
  • --title: the file title.

Example use:

gulp tohtml --path **/*.md --title demo-page 

AnyWhere,Before you start your work for it ,now please see dist/index.html. The source code of index.md is a demo article, the generated index.html look like below:

There is also a online demo page

MIT License Copyright (c) 2017 xbynet Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

一款使用 gulp 开发的小工具,用于进行 Markdown 到 Html 的转换,相比同类工具的优势,支持自动 TOC 即自动根据标题生成目录,同时也支持代码高亮等 展开 收起
JavaScript 等 3 种语言
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
JavaScript
1
https://gitee.com/mirrors/markdown2html-cli.git
git@gitee.com:mirrors/markdown2html-cli.git
mirrors
markdown2html-cli
markdown2html-cli
master

搜索帮助