有2个grunt插件用于为Angularjs应用程序生成文档.
https://www.npmjs.org/package/grunt-ngdoc
https://www.npmjs.org/package/grunt-ngdocs
有什么区别,我应该使用哪一个?
咕噜,ngdoc
ngdoc: {
options: {
dest: 'docs'
scripts: ['../app.min.js'],
html5Mode: true,
startPage: '/api',
title: 'My Documentation',
analytics: {
account: 'UA-08150815-0',
domainName: 'my-domain.com'
},
discussions: {
shortName: 'my',
url: 'http://my-domain.com',
dev: false
}
},
tutorial: {
src: ['content/tutorial/*.ngdoc'],
title: 'Tutorial'
},
api: {
src: ['src/**/*.js', '!src/**/*.spec.js'],
title: 'API Documentation'
}
}
ngdocs
ngdocs: {
options: {
dest: 'docs'
scripts: ['../app.min.js'],
html5Mode: true,
startPage: '/api',
title: "My Awesome Docs",
image: "path/to/my/image.png",
imageLink: "http://my-domain.com",
titleLink: "/api",
bestMatch: true,
analytics: {
account: 'UA-08150815-0',
domainName: 'my-domain.com'
},
discussions: {
shortName: 'my',
url: 'http://my-domain.com',
dev: false
}
},
tutorial: {
src: ['content/tutorial/*.ngdoc'],
title: 'Tutorial'
},
api: {
src: ['src/**/*.js', '!src/**/*.spec.js'],
title: 'API Documentation'
}
}
Sel*_*lah 14
我今天想知道同样的事情.我注意到ngdocs https://github.com/m7r/grunt-ngdocs正在经历比ngdoc https://github.com/bevacqua/grunt-ngdoc更积极的开发.结果我决定选择ngdocs.
更新:我尝试了两个,并能够让ngdocs为我的项目工作,但无法使ngdoc工作.