Custom Docs Generation

Stencil exposes an output target titled docs-custom where users can access the generated docs json data. This feature can be used to generate custom markdown or to execute additional logic on the comment metadata during the build process.

To make use of this output target, add the docs-custom output target to your Stencil configuration.

import { Config } from '@stencil/core';

export const config: Config = {
  outputTargets: [
    {
      type: 'docs-custom',
      generator: (docsJsonData) => {
          // Custom logic goes here
      },
      strict: true
    }
  ]
};

Configuring docs-custom

docs-custom is able to be configured in a Stencil config with the following properties:

Custom Docs Data Model

JsonDocs

The generated docs JSON data that a generator function will operate on will be the type of JsonDocs. It contains metadata for each component in the project, as well as information used to determine which versions of Stencil/TypeScript generated the metadata.

JsonDocsComponent

JsonDocsComponent contains the metadata for a single component in a project