chkc_help/
lib.rs

1//! tiny clap help renderer with markdown output and a bit of color.
2//!
3//! the flow is simple:
4//! - parse args with clap and send your match arm into `help_command` (or the `_docs` variant if
5//!   you registered extra notes)
6//! - `HelpPage` turns clap metadata into markdown-friendly structs
7//! - `renderer` prints it with `termimad`, scrolling automatically if it doesn't fit
8//! - `HelpTheme` keeps colors consistent and swappable
9//!
10//! everything is re-exported from here so you rarely need to dig into submodules.
11
12mod doc_registry;
13mod help_command;
14mod help_page;
15mod renderer;
16mod theme;
17
18pub use doc_registry::{CommandDoc, DocRegistry};
19pub use help_command::{
20    help_command, help_command_docs, help_command_program, help_command_program_docs, resolve_help, run_help_topic, HelpArgs,
21    HelpTarget,
22};
23pub use help_page::HelpPage;
24pub use renderer::{render_command_help, run_scrollable_help};
25pub use theme::{apply_accent, HelpTheme};
26
27pub use termimad::crossterm::style::Color;
28pub use termimad::MadSkin;