Skip to content
Documentation generators
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
api-docs
docstrap
jsdoc
typedoc
.gitignore
LICENSE.md
README.md
index.js
package-lock.json
package.json

README.md

Highcharts Documentation Generators

This package repository contains the documentation generators to build the API documentation.

API Docs

This generator is responsible for the build/api/ product folders in the highcharts repository. It contains a handlebars template system and library scripts that are used by gulp tasks in the highcharts repository. It depends on the tree.json file generated by the JSDoc plugin jsdoc/plugins/highcharts.jsdoc.js. See the included readme for more information.

gulp.src(sourceFiles, { read: false })
    .pipe(jsdoc({
        plugins: ['./tools/jsdoc/plugins/highcharts.jsdoc']
    }, error => console.error(error)));
require('highcharts-documentation-generators')
    .ApiDocs('./tree.json', './build/api', true);

DocStrap

The generator is not used that much anymore. Basically it provides the template for JSDoc to generate the build/api/class-reference folder in the highcharts repository. The folder of interest is therefor docstrap/template. See the included readme for common information.

gulp.src(sourceFiles, { read: false })
    .pipe(require('gulp-jsdoc3')({
        navOptions: {
            theme: 'highsoft'
        },
        opts: {
            template: './node_modules/highcharts-documentation-generators/docstrap'
        },
        templates: {
            theme: 'highsoft'
        }
    }, error => console.error(error)));

TypeDoc

The generator is not ready yet. It contains a handlebars template system and library scripts to generate future documentation out of TypeScript source code. See the included readme for development information.

gulp.src(sourceFiles, { read: false })
    .pipe(require('gulp-typedoc')({
        theme: './node_modules/highcharts-documentation-generators/typedoc/theme'
    })
    .on('error', console.error)
    .on('end', console.log);
You can’t perform that action at this time.