Workbench

module.exports = {
  pathToSource: '../../../../src',
  pathToDist: '../../../content/api',
  urlPrefix: '/api/',
  whitelist: [ /* ... */ ], // todo it will be removed.
  seo: {
    'dataMap/metaManager/metaSchema.js': {
      title: 'Options',
      metaTitle: 'Options - API Reference - Handsontable Documentation',
    },
    /* ... */
  },
  linkAliases: {
    options: 'metaSchema',
    hooks: 'pluginHooks'
  }
};

For customizing a template goes into ./integrations/jsdoc-to-markdown/dmd/partials. There are all partials from dmd package (which render markdown files from parsed jsdoc). To replace a partial, please add prefix hot- and find and rename all usages.

Dependency flow

PlantUML code

Edit

@startuml

interface "(NPM) jsdoc-to-markdown"
interface "logger"

package "jsdoc-convert" {
  package "integrations/jsdoc-to-markdown" {
    [dmd/ (Output templates)]
    [integrator.mjs]
    interface buildJsdocToMarkdownIntegrator
  }

  package "renderer" {
    [preProcessor.mjs]
    [preProcessors/*]

    [postProcessor.mjs]
    [postProcessors/*]

    [seo.mjs]

    [renderer.mjs]

    interface buildRenderer
  }
  package "parser" {
    [parser.mjs]

    interface buildParser
  }


  [configuration.js]
  [paths.mjs]

  [index.mjs]
}

[integrator.mjs] --up--( [(NPM) jsdoc-to-markdown]
buildJsdocToMarkdownIntegrator -up-> [integrator.mjs]
[integrator.mjs] -right->  [dmd/ (Output templates)]


[renderer.mjs] -up-> [preProcessor.mjs]
[renderer.mjs] -up-> [preProcessors/*]
[renderer.mjs] -up-> [postProcessor.mjs]
[renderer.mjs] -up-> [postProcessors/*]
[renderer.mjs] -up-> [seo.mjs]
buildRenderer -up-> [renderer.mjs]

buildParser -up-> [parser.mjs]

[index.mjs] -up-( buildJsdocToMarkdownIntegrator
[index.mjs] -up-( buildRenderer
[index.mjs] -up-( buildParser
[index.mjs] -up-( logger
[index.mjs] -up-> [configuration.js]
[index.mjs] -up-> [paths.mjs]

@enduml