Skip to main content

nxdoc:generate-index

Generate Index Executor​

Options​

check​

  • (boolean): Error if documentation would change. Useful for CI.

exclude​

  • (string): Comma separated list of packages to exclude from the generated docs.

outputDirectory​

  • (string): Where should the generated docs be placed?

Default: "docs"

projects​

  • (string): Comma separated list of projects to include in the generated docs.

skipFrontMatter​

  • (boolean): NxDoc generates frontmatter suitable for docusaurus by default.