Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebHelpGenerator

Imperative web help generator. Accepts the command definitions and constructs the full help text for the command node.

export

Hierarchy

  • WebHelpGenerator

Index

Constructors

constructor

Properties

Private aliasList

aliasList: {}

Key value list of commands and their aliases

memberof

WebHelpGenerator

Type declaration

  • [key: string]: string[]

Private mConfig

Imperative config containing data about the CLI

memberof

WebHelpGenerator

Private mDocsDir

mDocsDir: string

Output directory for HTML doc pages

memberof

WebHelpGenerator

Private mFullCommandTree

mFullCommandTree: ICommandDefinition

Imperative command tree to build help for

memberof

WebHelpGenerator

Private markdownIt

markdownIt: any

Markdown-it module used to convert markdown to HTML

memberof

WebHelpGenerator

sanitizeHomeDir

sanitizeHomeDir: boolean = false

Specifies whether user's home directory should be redacted from help content

memberof

WebHelpGenerator

Private singlePageHtml

singlePageHtml: string

Used to build single page version of web help

memberof

WebHelpGenerator

Private treeNodes

treeNodes: IWebHelpTreeNode[]

List of nodes in command tree

memberof

WebHelpGenerator

Methods

Private appendToSinglePageHtml

  • appendToSinglePageHtml(definition: ICommandDefinition, rootCommandName: string, fullCommandName: string, htmlContent: string): void

Private buildChildrenSummaryTables

Private buildCmdTreeHtml

buildHelp

Private genBreadcrumb

  • genBreadcrumb(rootCommandName: string, fullCommandName: string): string

Private genCommandHelpPage

Private genDocsFooter

  • genDocsFooter(): string

Private genDocsHeader

  • genDocsHeader(title: string): string

Private genPrintButton

  • genPrintButton(): string

Private renderMarkdown

  • renderMarkdown(markdownContent: string): string

Private writeTreeData

  • writeTreeData(): void

Generated using TypeDoc