External module "html"

Index

Interfaces

Type aliases

Functions

Type aliases

GetFooterFunction

GetFooterFunction: function

Function to generate (additional) footer content.

returns: The generated HTML code.

Type declaration

- (): string
- Returns string

GetHeaderButtonsFunction

GetHeaderButtonsFunction: function

Function to generate header buttons.

returns: The generated HTML code.

Type declaration

- (): string
- Returns string

GetResourceUriFunction

GetResourceUriFunction: function

The function that returns the URI of a resource.

param: The path inside the resource directory.
returns: The URI.

Type declaration

- (path: string): vscode.Uri
- Parameters
  - path: string
  Returns vscode.Uri

Functions

generateFooter

generateFooter(opts: GenerateFooterOptions): string

- Defined in html.ts:132
Generates the common content for footer.

Parameters
- opts: GenerateFooterOptions
  
  Options.
Returns string

The generated HTML code.

generateHeader

generateHeader(opts: GenerateHeaderOptions): string

- Defined in html.ts:155
Generates the common content for 'head' tag.

Parameters
- opts: GenerateHeaderOptions
  
  Options.
Returns string

The generated HTML code.

generateHtmlDocument

generateHtmlDocument(opts: GenerateHtmlDocumentOptions): string

- Defined in html.ts:237
Generates a full HTML document.

Parameters
- opts: GenerateHtmlDocumentOptions
  
  Options.
Returns string

The generated HTML code.

generateNavBarHeader

generateNavBarHeader(opts: GenerateNavBarHeaderOptions): string

- Defined in html.ts:266
Generates the common HTML for a header navbar.

Parameters
- opts: GenerateNavBarHeaderOptions
  
  Options.
Returns string

The generated HTML code.

getDocumentTitle

getDocumentTitle(title: string): string

- Defined in html.ts:301
Parameters
- title: string
Returns string

Generated using TypeDoc