UNPKG

738 BTypeScriptView Raw
1/**
2 * Markdown renderer for opening the instructions md file inside the
3 * terminal or the browser.
4 */
5export declare class MarkdownRenderer {
6 private mdFileAbsPath;
7 private packageName;
8 constructor(mdFileAbsPath: string, packageName: string);
9 /**
10 * Generates HTML with the markdown processed code
11 */
12 private generateHtml;
13 /**
14 * Opens the html contents by writing it to a temporary
15 * file and opens up the file inside the browser.
16 */
17 private openContentsInBrowser;
18 /**
19 * Converts markdown to HTML and opens it up inside the browser
20 */
21 renderInBrowser(): Promise<void>;
22 /**
23 * Writes markdown in the terminal
24 */
25 renderInTerminal(): Promise<void>;
26}