Skip to main content

@nx-dotnet/nxdoc:generate-docs

Options#

outputDirectory#

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

gettingStartedFile#

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

skipFrontMatter#

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

skipFormat#

  • (boolean): Skips running the output through prettier