如何为yuidoc添加IgnorePath

时间:2013-04-19 07:39:26

标签: yuidoc

在生成yuidoc文档时,我想忽略我项目的lib文件夹中下载的javascript库。如何将其置于忽略列表中 我试过了     "ignorePaths": [ "./lib" ],     "ignorePaths": [ "./lib/*.js" ],     "ignorePaths": [ "lib" ]

仍然在编译我的javascript库文件。

2 个答案:

答案 0 :(得分:1)

相反,请尝试使用https://github.com/yui/yuidoc/issues/5

中讨论的exclude选项

"exclude" : ["lib"]

答案 1 :(得分:0)

我添加了一个更详细的答案,因为我昨天遇到了这个问题,这可能对其他人有所帮助。

正如@slolife所提到的,你应该使用"exclude"

"exclude"的值必须是以逗号分隔的目录(不是数组)的字符串。这可以通过您的JSON配置文件作为"options"之一或作为命令行参数来完成。

单个目录示例

JSON配置文件

{
    "name": "My Project",
    "options": {
        "exclude": "lib"
    }
}

<强>命令行

yuidoc . -x "lib"


多个目录示例

注意: 列表中的目录之间没有空格

JSON配置文件

{
    "name": "My Project",
    "options": {
        "exclude": "lib,lib2"
    }
}

<强>命令行

yuidoc . -x "lib","lib2"

参考:http://yui.github.io/yuidoc/args/index.html