蛋疼写了个 node.js 版的 daux.io

2013-10-17 17:16:46 +08:00
 kaelzhang
最近用 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 设置本地端口


陆续会加入更多特性,只有一个目标,搭文档站要无脑,不要超过一分钟。
4664 次点击
所在节点    Node.js
5 条回复
cfddream
2013-10-17 17:24:28 +08:00
@kaelzhang 请贴repo地址
deepure
2013-10-17 18:00:31 +08:00
看描述跟doxmate是一类?
kaelzhang
2013-10-17 18:16:45 +08:00
kaelzhang
2013-10-17 18:18:18 +08:00
目前直接拿 daux.io 的设计了,下个版本会开放 theme 的 api。
ianva
2013-10-17 20:35:53 +08:00
@kaelzhang 可以附言在主题下面比较明显,正好也准备弄个 js 文档的文档生成,css 现在用的 kss-node 也不好用,现在还在点评么

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/85912

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX