V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
kaelzhang
V2EX  ›  Node.js

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

  •  
  •   kaelzhang · 2013-10-17 17:16:46 +08:00 · 4687 次点击
    这是一个创建于 4090 天前的主题,其中的信息可能已经有所发展或是发生改变。
    最近用 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 设置本地端口


    陆续会加入更多特性,只有一个目标,搭文档站要无脑,不要超过一分钟。
    第 1 条附言  ·  2013-10-17 21:00:20 +08:00
    5 条回复    1970-01-01 08:00:00 +08:00
    cfddream
        1
    cfddream  
       2013-10-17 17:24:28 +08:00   ❤️ 1
    @kaelzhang 请贴repo地址
    deepure
        2
    deepure  
       2013-10-17 18:00:31 +08:00 via iPhone
    看描述跟doxmate是一类?
    kaelzhang
        3
    kaelzhang  
    OP
       2013-10-17 18:16:45 +08:00
    kaelzhang
        4
    kaelzhang  
    OP
       2013-10-17 18:18:18 +08:00
    目前直接拿 daux.io 的设计了,下个版本会开放 theme 的 api。
    ianva
        5
    ianva  
       2013-10-17 20:35:53 +08:00
    @kaelzhang 可以附言在主题下面比较明显,正好也准备弄个 js 文档的文档生成,css 现在用的 kss-node 也不好用,现在还在点评么
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   2636 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 23ms · UTC 07:05 · PVG 15:05 · LAX 23:05 · JFK 02:05
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.