Skip to content
This repository has been archived by the owner on Mar 8, 2023. It is now read-only.

hyurl/sfn-markdown-parser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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>
}

About

Simple markdown parser for SFN framework.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published