0.1.1 • Published 6 years ago

sfn-markdown-parser v0.1.1

Weekly downloads
3
License
MIT
Repository
github
Last release
6 years ago

SFN-Markdown-Parser

Simple markdown parser for SFN framework.

This module uses marked, highlightjs and comment-meta to parse and render markdown files.

API

namespace MarkdownParser {
    /** Parses markdown contents to HTML. */
    function parse(contents: string): Promise<string>;
    /** Parses a markdown file to HTML. */
    function parseFile(filename: string, encoding = "utf8"): Promise<string>;
    /** Gets the title of a markdown document. */
    function getTitle(content: string): string;
    /** Gets the title of a markdown document. */
    function getFileTitle(filename: string, encoding = "utf8"): Promise<string>
}