/yapi-markdown-render

render markdown to html

Primary LanguageJavaScriptMIT LicenseMIT

yapi-markdown-render

核心代码从tui.editor中提取 利用markdown-it将markdown渲染成html

初始化

yarn install

或者

npm install

渲染markdown文件

/node render.js xxx.md

获取easy-yapi配置

服务器渲染配置

1.将服务器上部署此项目

执行

yarn start
#yarn start 3000

或者

npm start
#npm start 3000

2.在easy-yapi配置文件中做如下配置

配置示例:

markdown.render.server=http://服务器ip:端口/render

本地渲染配置

本地渲染性能稍高，无需部署

1.执行shell,复制脚本输出的内容(即为配置)

./script/build_conf.sh

2.将配置放入项目中的配置文件里,项目配置文件配置方法见: 项目配置方法

配置示例:

markdown.render.shell=/usr/local/bin/node render.js
markdown.render.work.dir=/项目路径/yapi-markdown-render
markdown.render.timeout=3000