Nozzle Piping Mismatch

    grunt-apidox

    2.0.17 • Public • Published

    grunt-apidox    ci Coverage Status NPM version

    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 the input filename but with the extension changed to .md.

    • outdir (optional, string): Subdirectory to write output file into.

    • inputTitle (optional, string |false): By default, apidox includes a line in the markdown saying it was generated from the input file. Set inputTitle to false 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. Set fullSourceDescription to true 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 in sections 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. Set extraHeadingLevels if you want to change this. For example, to generate level 3 headings, set extraHeadingLevels 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

    MIT

    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

    Install

    npm i grunt-apidox

    DownloadsWeekly Downloads

    50

    Version

    2.0.17

    License

    MIT

    Unpacked Size

    112 kB

    Total Files

    22

    Last publish

    Collaborators

    • davedoesdev