Skip to main content

nxdoc:generate-docs

Generate Docs Executor​

Executor for generating documentation for a single project.

Options​

outputDirectory​

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

Default: "docs/{projectName}"

project​

  • (string): The project that docs should be generated for.

check​

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

gettingStartedFile​

  • (string): File contents to place before the API reference section for each package. <src> is replaced by the package's root.

Default: "<src>/README.md"

skipFrontMatter​

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