Skip to main content

nxdoc:generate-index

Generate Index Generator​

Generator for generating an index that ties multiple projects together.

Options​

outputDirectory​

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

Default: "docs"

exclude​

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

projects​

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

skipFormat​

  • (boolean): Skips running the output through prettier

skipFrontMatter​

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