grunt-apidox中文文档|grunt-apidox js中文教程|解析

npm npmdoc 2年前 (2021-12-19) 298次浏览

grunt-apidox中文文档|grunt-apidox js中文教程|解析

安装命令:npm i grunt-apidox

咕噜声-apidox    词 覆盖状态 NPM 版本

使用apidox生成 Node.js API 降价的Grunt插件

例子:

grunt.initConfig(
{
    apidox: {
        input: 'index.js',
        output: 'README.md'
    }
});

grunt.loadNpmTasks('grunt-apidox');
grunt.registerTask('docs', 'apidox');

安装

npm install grunt-apidox

配置

apidox在 Grunt 配置中使用该属性。您可以提供以下选项:

  • input(必需,字符串):要为其生成文档的源文件名。您可以使用 Grunt 通配模式来指定多个文件。

  • output(可选,字符串):要写入降价的文件的名称。默认与input文件名相同,但扩展名更改为.md.

  • outdir(可选,字符串):要写入output文件的子目录

  • inputTitle(可选,字符串 | false):默认情况下,apidox在降价中包含一行,说明它是从input文件生成的设置inputTitlefalse以防止这种情况,或将其设置为字符串以更改文本。

  • fullSourceDescription(可选,布尔值):默认情况下,apidox仅包含输出中第一条评论的第一段。设置fullSourceDescriptiontrue在输出中包含所有第一个注释。

  • sections(可选,对象):使用它来将目录划分为多个部分。每个键sections是一个部分中第一个函数的名称。该值是在目录中函数链接之前插入的降价。

    使用带有空字符串的键在目录后插入降价。

  • extraHeadingLevels(可选,整数):默认情况下,apidox为每个 API 条目生成 1 级标题。设置extraHeadingLevels是否要更改此设置。例如,要生成 3 级标题,请设置extraHeadingLevels为 2。

更多例子

写入子目录:

apidox: {
    input: 'index.js',
    output: 'README.md',
    outdir: 'docs'
}

将 markdown 中源链接的文本设置为bar

apidox: {
    input: 'index.js',
    output: 'README.md',
    inputTitle: 'bar'
}

不显示源链接:

apidox: {
    input: 'index.js',
    output: 'README.md',
    inputTitle: false
}

写信给index.md

apidox: 'index.js'

使用通配符处理多个源文件并为每个源文件生成一个单独的 Markdown 文件:

apidox: {
    input: '*.js',
    outdir: 'docs'
}

使用通配符处理多个源文件并生成单个 Markdown 文件:

apidox: {
    input: '*.js',
    output: 'README.md'
}

将目录分成两部分,foo并且bar

apidox: {
    input: 'index.js',
    sections: {
        someFunction: '##foo',
        someOtherFunction: '##bar'
    }
}

执照

麻省理工学院

测试

grunt test

皮棉

grunt lint

代码覆盖率

grunt coverage

c8结果可在此处获得

工作服页面在这里

来源:tasks/apidox.js

— 由apidox 生成

项目贡献人员列表:


极客公园 , 版权所有丨如未注明 , 均为原创丨本网站采用BY-NC-SA协议进行授权
转载请注明原文链接:grunt-apidox中文文档|grunt-apidox js中文教程|解析
喜欢 (0)
.excerpt .focus {display:none}