jacksontian / doxmate Goto Github PK

1

issue #2中提到的Markdown页面问题，虽然现在能生成页面，但是有些格式貌似不支持：

比如这个文件：https://github.com/leizongmin/tinyliquid/blob/master/doc/filters.md

被编译成下面这样：

在「Changelog」界面是顶部导航栏相应的链接会有不一样的背景，但「API Docs」没有。

在Wordpress主题下。

另，目前导航好像是抓取二级标题生成的，多级目录要怎么配置？

如果当前目录下有templates目录，则优先使用当前templates里的模板

PS E:\doxmate> doxmate build
{ Error: spawn D:\nodejs\node_modules\doxmate\bin\doxmate-build ENOENT
at Process.ChildProcess._handle.onexit (internal/child_process.js:201:19)
at onErrorNT (internal/child_process.js:379:16)
at process._tickCallback (internal/process/next_tick.js:114:19)
at Function.Module.runMain (module.js:692:11)
at startup (bootstrap_node.js:194:16)
at bootstrap_node.js:666:3
errno: 'ENOENT',
code: 'ENOENT',
syscall: 'spawn D:\nodejs\node_modules\doxmate\bin\doxmate-build',
path: 'D:\nodejs\node_modules\doxmate\bin\doxmate-build',
spawnargs: [],
cmd: 'D:\nodejs\node_modules\doxmate\bin\doxmate-build' }
现在解决了, 提了pull

如上图，左边导航栏A应该设置成浮动的，否则当拖动滚动条后，这个导航栏就看不见了，不便于阅读。

同时API索引B应该放到左边导航栏中

你好，我按照官方的操作测试了一下，为何显示错误？
系统为64位 win7

谢谢！

我也没想出太好的解决办法，但是方法名就这么长，又不能随便改……

Live Bug Demo: http://gridjs.org/docs/API.html

js 代码高亮应该是模板的问题..不知道有没有默认加上的需要?

还有就是配置代码是否输出到文档,代码没必要在doc 文档上面显示吧....

frank$ doxmate -i ./doxmate/

path.js:313
throw new TypeError('Arguments to path.resolve must be strings');
^
TypeError: Arguments to path.resolve must be strings
at Object.exports.resolve (path.js:313:15)
at Object. (/usr/local/lib/node_modules/doxmate/bin/doxmate:38:25)
at Module._compile (module.js:456:26)
at Object.Module._extensions..js (module.js:474:10)
at Module.load (module.js:356:32)
at Function.Module._load (module.js:312:12)
at Function.Module.runMain (module.js:497:10)
at startup (node.js:119:16)
at node.js:901:3

➜ * git:(master) ✗ cd Application
➜ Application git:(master) ✗ doxmate build
{ [Error: Command failed:
module.js:340
throw err;
^
Error: Cannot find module '/Applications/XAMPP/xamppfiles/htdocs/**/Application/package.json'
at Function.Module._resolveFilename (module.js:338:15)
at Function.Module._load (module.js:280:25)
at Module.require (module.js:364:17)
at require (module.js:380:17)
at Object.exports.process (/usr/local/lib/node_modules/doxmate/lib/doxmate.js:164:13)
at Object. (/usr/local/lib/node_modules/doxmate/bin/doxmate-build:36:9)
at Module._compile (module.js:456:26)
at Object.Module._extensions..js (module.js:474:10)
at Module.load (module.js:356:32)
at Function.Module._load (module.js:312:12)
] killed: false, code: 8, signal: null }

1.doxmate build （3种模版下）
2.左边子导航功能失效

内容 h1 h2 等标签 id 无法正确输出

微信公众号接收消息会触发三次

如以下注释信息不能正确生成：

/**
 * 合并对象
 *
 * @api private
 */

怎么生成PHP文档哪？

注释文本：

/**
 * 创建日志记录器
 *
 * @param {String} name 日志记录器名称
 * @param {Object} options
 *   - {String} path 日志主目录，默认为./log
 *   - {Number} interval 保存周期，默认为2000ms
 *   - {String} level 等级，fatal > error > warn > info > debug，默认为debug
 *   - {Boolean} output 是否在控制台输出，默认为true
 * @api public
 */

输出的页面显示如下：

这样很明显是影响阅读的。建议对于未知的注释类型，可以把它隐藏起来（起码比显示undefined强），或者有神马好的注释写法来说明上面的options参数？

出错信息如下：

undefined:24
  throw err;
        ^
ReferenceError: F:\github\doxmate\templates\index.html:6
    4|     <div class="span3 bs-docs-sidebar">
    5|       <% include sidebar %>
 >> 6|     </div>
    7|     <div class="span9">
    8|       <% for (var key in apis) {
    9|         var api = apis[key];

keywords is not defined
    at buf.push..
<div class="container content">
  <div class="row">
    <div class="span3 bs-docs-sidebar">
      .buf (eval at <anonymous> (F:\github\doxmate\node_modules\ejs\lib\ejs.js:234:12))
    at eval (eval at <anonymous> (F:\github\doxmate\node_modules\ejs\lib\ejs.js:234:12))
    at exports.compile (F:\github\doxmate\node_modules\ejs\lib\ejs.js:239:15)
    at Object.exports.render (F:\github\doxmate\node_modules\ejs\lib\ejs.js:277:13)
    at Object.exports.process (F:\github\doxmate\lib\doxmate.js:162:57)
    at Object.<anonymous> (F:\github\doxmate\bin\doxmate:47:9)
    at Module._compile (module.js:449:26)
    at Object.Module._extensions..js (module.js:467:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)

1.首页在Chrome下显示位置有重叠：

2.没有指定页面编码，浏览器默认为GBK时显示乱码：

3.顶栏后面那两个链接是原来的doc目录里有的Markdown文件，但是没有正确转为HTML：