Skip to main content

Getting Started

This package is unstable! Documentation formatting could change in the future. See something that you think should be different? Open an issue on github and help shape this plugin.

Prerequisites#

  • Have an existing nx workspace containing an Nx plugin project. For creating this, see nrwl's documentation.

Installation#

NPM#

npm i --save-dev @nx-dotnet/nxdoc

PNPM#

pnpm i --save-dev @nx-dotnet/nxdoc

Yarn#

yarn add --dev @nx-dotnet/nxdoc

Generate Documentation#

Generate markdown docs in the /docs folder of your repository for each plugin in the workspace

npx nx g @nx-dotnet/nxdoc:generate-docs --outputPath docs

API Reference

Generators#

generate-docs#

Automatic documentation generator for Nx Plugins