Package Exports
- @nx-dotnet/nxdoc
- @nx-dotnet/nxdoc/src/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@nx-dotnet/nxdoc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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/nxdocPNPM
pnpm i --save-dev @nx-dotnet/nxdocYarn
yarn add --dev @nx-dotnet/nxdocGenerate 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