grunt-apidox v3.1.1
grunt-apidox
Grunt plugin to generate Node.js API markdown using apidox.
Example:
grunt.initConfig(
{
apidox: {
input: 'index.js',
output: 'README.md'
}
});
grunt.loadNpmTasks('grunt-apidox');
grunt.registerTask('docs', 'apidox');
Installation
npm install grunt-apidox
Configuration
Use the apidox
property in your Grunt config. You can supply the following options:
input
(required, string): Source filename to generate documentation for. You can use Grunt globbing patterns to specify more than one file.output
(optional, string): Name of the file to write the markdown into. Defaults to the same as theinput
filename but with the extension changed to.md
.outdir
(optional, string): Subdirectory to writeoutput
file into.inputTitle
(optional, string |false
): By default,apidox
includes a line in the markdown saying it was generated from theinput
file. SetinputTitle
tofalse
to prevent this, or set it to a string to change the text.fullSourceDescription
(optional, boolean): By default,apidox
includes only the first paragraph of the first comment in the output. SetfullSourceDescription
totrue
to include all of the first comment in the output.sections
(optional, object): Use this to divide the table of contents into sections. Each key insections
is the name of the first function in a section. The value is the markdown to insert before the link to the function in the table of contents.Use a key with the empty string to insert markdown after the table of contents.
extraHeadingLevels
(optional, integer): By default,apidox
generates level 1 headings for each API entry. SetextraHeadingLevels
if you want to change this. For example, to generate level 3 headings, setextraHeadingLevels
to 2.
More Examples
Write to a subdirectory:
apidox: {
input: 'index.js',
output: 'README.md',
outdir: 'docs'
}
Set the text of the source link in the markdown to bar
:
apidox: {
input: 'index.js',
output: 'README.md',
inputTitle: 'bar'
}
Don't show source link:
apidox: {
input: 'index.js',
output: 'README.md',
inputTitle: false
}
Write to index.md
:
apidox: 'index.js'
Use a wildcard to process multiple source files and generate a separate markdown file for each one:
apidox: {
input: '*.js',
outdir: 'docs'
}
Use a wildcard to process multiple source files and generate a single markdown file:
apidox: {
input: '*.js',
output: 'README.md'
}
Split the table of contents into two sections, foo
and bar
:
apidox: {
input: 'index.js',
sections: {
someFunction: '##foo',
someOtherFunction: '##bar'
}
}
Licence
Tests
grunt test
Lint
grunt lint
Code Coverage
grunt coverage
c8 results are available here.
Coveralls page is here.
Source: tasks/apidox.js
—generated by apidox—
4 months ago
6 months ago
1 year ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
7 years ago
8 years ago
8 years ago
9 years ago
9 years ago
9 years ago
10 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago