我花了4天的时间试图让yuidoc解析我的javascript框架,这真的让我疯狂。
这是我的json配置文件
{ linkNatives: 'true',
attributesEmit: 'true',
paths: [ '..\\\\layers' ],
outdir: '../docs/',
port: 3000,
nocode: true,
extension: '.js',
project:
{ name: '{NAME}',
description: '{DESCRIPTION}',
version: '1.0.0',
url: 'http://docs.mysite.com/',
logo: 'http://docs.mysite.com/img/logo.png',
themedir: 'yuidoc-bootstrap-theme' } }
它正在解析json配置并且没有错误。这是输出:
$ yuidoc ../layers
info: (yuidoc): Starting YUIDoc@0.3.46 using YUI@3.9.1 with NodeJS@0.10.24
info: (yuidoc): Scanning for yuidoc.json file.
info: (yuidoc): Loading yuidoc.json data from: C:\devtools\GitHub\Framework\tools\yuidoc.json
info: (yuidoc): Starting YUIDoc with the following options:
info: (yuidoc):
{ linkNatives: 'true',
attributesEmit: 'true',
paths: [ '..\\\\layers' ],
outdir: '../docs',
port: 3000,
nocode: false,
project:
{ name: '{NAME}',
description: '{DESCRIPTION}',
version: '1.0.0',
url: 'http://docs.mysite.com/',
logo: 'http://docs.mysite.com/img/logo.png',
themedir: 'yuidoc-bootstrap-theme' } }
info: (yuidoc): YUIDoc Starting from: ..\\layers
Nlaak@Nlaak-PC /cygdrive/c/devtools/GitHub/Framework/tools
$
我可以使用命令行和输出和主题的默认设置来使用它,但它没有我的项目构建和版本信息。 Bootstrap主题在Github上运行。我在Windows 7 64位上使用Cygwin 64位。
我有...... - 检查行结尾 - 以最少的编辑复制和粘贴yuidocs示例 - 尝试命令行每个方向 - 验证所有路径和目录存在
HELP!为什么没有错误也没有输出。
答案 0 :(得分:1)
我认为在应用自定义配置时,YUIDoc中存在一个错误。
尝试在配置JSON中添加带有'outdir'条目的'output'属性。
E.g。类似的东西:
{
linkNatives: 'true',
attributesEmit: 'true',
paths: ['..\\\\layers'],
port: 3000,
nocode: true,
extension: '.js',
project: {
name: '{NAME}',
description: '{DESCRIPTION}',
version: '1.0.0',
url: 'http://docs.mysite.com/',
logo: 'http://docs.mysite.com/img/logo.png',
themedir: 'yuidoc-bootstrap-theme',
options: {
outdir: '..\out'
}
}
}
答案 1 :(得分:1)
像
一样创建yuidoc.json{
"name": "yout title",
"version": "1.0.0",
"options": {
"outdir": "./docs"
}
}
并在您的终端中运行
c://user/test> yuidoc . -c yuidoc.json --server <js filder path ex: ./example>