Docs Config

The docs config option allows global configuration of certain behaviors related to documentation generation output targets.

note

These configurations are global and will be applied to all output target instances including those defined in the outputTargets configuration, as well as those injected by CLI flags (like --docs).

markdown

The markdown config object allows certain customizations for markdown files generated by the docs-readme output target or the --docs CLI flag.

targetComponent

Optional

Default: { textColor: '#333', background: '#f9f' }

This option allows you to change the colors used when generating the dependency graph mermaid diagrams for components. Any hex color string is a valid value.

stencil.config.ts

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

export const config: Config = {
  docs: {
    markdown: {
      targetComponent: {
        textColor: '#fff',
        background: '#000',
      },
    },
  },
};