最近用 daux.io 创建几个文档站(想要把它安装在子目录中),结果,发现页面里面的相对路径和静态文件地址各种出问题。
无奈跳进它的源代码,直接给跪了(逻辑揉到一起,抓狂啊),干脆晚上花了点时间写了个。
安装方法:
npm install document -g # 可能需要 sudo
cd <你的项目根目录>
document
然后就可以下班回家了,谢谢各位。
大致原理:
`document` 对基于 commonjs 的项目支持较好,会读取 package.json 里面的内容。并将 `directories.doc` 的值(缺省为 'doc')作为文档根目录。
然后把各种文档扔到 `doc` 目录下就 OK 了。其他方式和 daux.io 类似。
如果要把目录安装在子目录上(比如 /docs ),在 `doc` 下创建一个 config.json 文件,并设置 `site_root` 的值,然后如果你有 nginx,加一个 location:
location /docs {
proxy_pass
http://127.0.0.1:<port>
}
即可。
基本参数:
--cwd, -c 设置工作路径
--doc 指定文档目录
--port, -p 设置本地端口
陆续会加入更多特性,只有一个目标,搭文档站要无脑,不要超过一分钟。