简单的文档生成工具 idoc
发布于 4 年前 作者 jaywcjlove 4498 次浏览 最后一次编辑是 3 年前 来自 分享

简单的文档生成工具

github 源码>>
生成的页面预览效果
通过markdown生成静态页面的AIP文档生成工具。

收录文档

这些文档是都是使用idoc生成的页面哦,可以提交用idoc生成的文档哦提交收录

  1. JSLite.io - 这个是现代浏览器类似jQuery的库,体积小。
  2. idoc - 通过markdown生成静态页面的工具
  3. store.js - js本地存储操作
  4. cookie.js - js本地cookie操作
  5. iNotify - 浏览器各种方法通知

生成的界面预览

default.png

handbook.png

常用命令

install

通过 npm 全局安装 idoc

$ npm install idoc -g

init

初始化文档文件

# 默认生成模板和配置文件,将当前文件夹根目录的所有md文件参数生成到配置文件package.json中
$ idoc init
# 将指定的 md 文件拷贝到当前目录下,生成模板和配置文件
$ idoc init ~/md/JSLite.md
# 将指定的两个 md 文件拷贝到当前目录下
$ idoc init ~/git/_idc/package.md  ~/git/_idc/dir/directory.md
# 将指定的 _idc 目录下的所有 md 文件拷贝到当前目录下
$ idoc init ~/git/_idc/

# 指定生成模板和配置文件
# 将“JSLite.md hotkeys.md”两个 md 文件拷贝到指定目录 `~/idoc/` 下面
# 生成模板需要的文件
# 第一个 md 文件是首页
$ idoc init JSLite.md hotkeys.md -C ~/idoc/

build

生成静态 HTML 页面到指定目录中

$ idoc build

watch

监控 md 文件发生变化自动 build

$ idoc watch

模板目录

# idoc/lib/theme/default/
./default
  ├── footer.ejs
  ├── gitignore
  ├── head.ejs
  ├── header.ejs
  ├── layout.ejs
  └── source
      ├── css
      │   ├── highlight.styl
      │   ├── main.styl
      │   ├── markdown.styl
      │   ├── reset.styl
      │   └── vendor.styl
      ├── img
      └── js

css

样式使用 stylus 来写默认 main.styl 会自动生成 main.css ,供页面引用。你也可以写纯css 在页面中引用。

source

默认会将此目录的中除 .styl 以外的文件复制到根目录中。

layout

布局文件默认放到主题目录的根目录,例如:主题default的布局文件默认是更目录的所有ejs,默认 layout.ejs 为入口模板

主题工具

主题里面使用的工具说明

ejs

选择 ejs 作为模板引擎,模板引擎选择ejs,我只想要一个简单的帮我填充数据的模板。github 文档 ejs.co

stylus

Stylus功能上更为强壮,和js联系更加紧密。官方文档 张鑫旭老师的中文翻译 Try Stylus!

TODO

TODO

  • [x] idoc 基本命令定义
  • [x] 添加 build 命令,markdown生成静态页面
  • [x] 添加 watch 命令,监控markdown文件自动生成HMTL页面
  • [x] 默认模板制作
  • [x] 树形菜单生成
  • [x] 添加 server 命令,预览生成的静态页面
  • [x] 添加多页面导航菜单
  • [x] 添加 clean 命令
  • [x] 静态资源相对路径引用
  • [ ] 判断是否存在markdown树形导航菜单
  • [x] 第二个模板制作
  • [x] 模板切换命令
  • [ ] api 检索功能
  • [x] 兼容windows路径(cmd工具冒得问题嘞)
2 回复

@i5ting 好吧,我的比你的好玩儿哦。 😄

回到顶部