ut-help
Generate help files for UT implementations, by including content from all the relevant modules.
Setup
-
Install
ut-help
globally. -
Add
.docusaurus
in.gitignore
. -
Modify package.json to call
ut-help
in the appropriate places:{ "scripts":{ "help": "ut-help build --out-dir dist/help", "help:start": "ut-help start --no-open", "release": "ut-webpack --mode production && ut-help build --out-dir dist/help && ut-release", } }
-
Create
utHelp.js
in the root of your project:module.exports = { resolve: require.resolve, include: [ 'ut-core', 'ut-customer', // include other packages here ] };
-
Follow the ut-microservice front end folder structure to include help files in each module.