Skip to content

将多个markdown文件转化成单页面带索引的index.html文件工具,可以用于个人写API文档、博客合集、一口气教程等等

Notifications You must be signed in to change notification settings

jzfuqian/my-mds2index.html

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status MIT Licence stable

my-mds2index.html

多个Markdown文档转化为带索引的单HTML页面

使用说明

  1. 去relase下载打包好的文件my-mds2index.htmlv1.0.0.zip
  2. 将你的markdown文件放入 markdowns/ 文件夹下面
  3. 编辑 config/config.yml将你的markdown文件的文件名按你想要展示的顺序添加到 markdowns/ 属性下面,添加格式参照你第一次打开看到的格式写法
  4. 点击 my-mds2index.html.exe.batbin/my-mds2index.html.bat(windows) ;sh bin/my-mds2index.html.sh (linux)
  5. 你要的单页面索引文件就在 output/ 文件夹下面

扩展使用

  1. template/index.html 可以修改,自定义生成页面的样式
  2. config/config.yml 可以修改,搭配模板
  3. 用命令运行脚本第一个参数可以带 脚本绝对路径 ,实现不同模板对应不同配置解析
  4. 热爱学习的可以自己去发现更多...

TODO-LIST

  1. 调试 shell脚本
  2. 学习完善 bat脚本

About

将多个markdown文件转化成单页面带索引的index.html文件工具,可以用于个人写API文档、博客合集、一口气教程等等

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 77.2%
  • HTML 16.4%
  • Shell 3.3%
  • Batchfile 3.1%