Skip to content

Commit

Permalink
Add clues about what help configuration is available to help with sea…
Browse files Browse the repository at this point in the history
…rches and encourage people to look further (#2294)
  • Loading branch information
shadowspawn authored Dec 8, 2024
1 parent 37e86af commit 02c603e
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -921,9 +921,11 @@ program.helpCommand('assist [command]', 'show assistance');
### More configuration

The built-in help is formatted using the Help class.
You can configure the Help behaviour by modifying data properties and methods using `.configureHelp()`, or by subclassing using `.createHelp()` if you prefer.
You can configure the help by modifying data properties and methods using `.configureHelp()`, or by subclassing Help using `.createHelp()` .

For more detail see (./docs/help-in-depth.md)
Simple properties include `sortSubcommands`, `sortOptions`, and `showGlobalOptions`. You can add color using the style methods like `styleTitle()`.

For more detail and examples of changing the displayed text, color, and layout see (./docs/help-in-depth.md)

## Custom event listeners

Expand Down

0 comments on commit 02c603e

Please sign in to comment.