Class MarkdownTranspiler

The main class to create an HTML-like file from a markdown file.

Hierarchy

MarkdownTranspiler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MarkdownTranspiler(options?: MarkdownTranspilerOptions): MarkdownTranspiler

- Defined in src/transpiler/markdown-transpiler.ts:17
Parameters
- Optional options: MarkdownTranspilerOptions
  
  Provides implementation details. If an implementation is not provided, will default to plain HTML generation. Other options may appear in the future.
Returns MarkdownTranspiler

Properties

Private fileCreator

fileCreator: FileCreator

Private parser

parser: MarkdownParser

Methods

Private getFileName

getFileName(filepath: string): string

- Defined in src/transpiler/markdown-transpiler.ts:79
Parameters
- filepath: string
Returns string

transpileFiles

transpileFiles(inputPattern: string, outputDir: string): Promise<void>

- Defined in src/transpiler/markdown-transpiler.ts:36
Transpiles files in batch (from file to file).

Parameters
- inputPattern: string
  
  A glob pattern for feeding input markdown files.
- outputDir: string
  
  A single directory to output transpiled files. Note that the folder structure will be flatten. The output filenames will match the input ones.
Returns Promise<void>

transpileText

transpileText(markdownContent: string, identifier?: undefined | string): string

- Defined in src/transpiler/markdown-transpiler.ts:68
Returns transpiled file content (from string to string).

Parameters
- markdownContent: string
  
  The markdown content to be transpiled.
- Optional identifier: undefined | string
  
  (optional) Used for naming the component (if needed). If not provided, a random string will be generated.
Returns string

Generated using TypeDoc