File:
commands.nu
4 exported commands
0 internal commandsgenerate-module-docs
Generate markdown documentation for the specified module already loaded in scope.
Usage
generate-module-docs <module_name> <output_file?>Parameters
module_name <string>- the module to generate docs for
output_file <string>- the output file (optional, default: 'docs.md')
Input/output types
| input | output |
|---|---|
| any | any |
Examples
Generate docs for nu-salesforce
generate-module-docs nu-salesforce nu-salesforce.mdgenerate-source-docs
Generate markdown documentation by loading source files from a module repo.
Usage
generate-source-docs <module_path?> <output_file?>Parameters
module_path <string>- module directory or mod.nu path (optional, default: '.')
output_file <string>- the output file (optional, default: 'docs.md')
Input/output types
| input | output |
|---|---|
| any | any |
Examples
Generate source-aware docs for nu-salesforce
generate-source-docs nu-salesforce/nu-salesforce nu-salesforce.mdgenerate-doc-site
Generate a static documentation site by loading source files from a module repo.
Usage
generate-doc-site <module_path?> <output_dir?> --light-theme <string> --dark-theme <string> --favicon-text <string>Parameters
module_path <string>- module directory or mod.nu path (optional, default: '.')
output_dir <string>- the directory to write the static site into (optional, default: 'site')
Flags
--light-theme <string>- bundled Shiki light theme name from themes.toml (default: 'rose-pine-dawn')
--dark-theme <string>- bundled Shiki dark theme name from themes.toml (default: 'rose-pine')
--favicon-text <string>- override favicon glyphs (defaults to the module name's initials) (default: '')
Input/output types
| input | output |
|---|---|
| any | any |
Examples
Generate a static site for nu-salesforce
generate-doc-site nu-salesforce/nu-salesforce siteview-docs
Quickly view all the exported commands for a given module in your default pager.
Usage
view-docs <module_name>Parameters
module_name <string>- the module you want to explore
Input/output types
| input | output |
|---|---|
| any | any |
Examples
view the docs for nu-salesforce
view-docs nu-salesforce