flatmarkdown-ast2html

Renders the Flat Markdown AST to HTML in a web page.

This npm package is the Rust crate flatmarkdown-ast2html, built as WebAssembly. So the package and the crate give the same HTML. The version of the package is the version of the crate.

The HTML is described in the README of the crate.

Use

The package is one JavaScript file, dist/index.global.js. The WebAssembly code is inside that file, so a page needs no second file. Load the file with a <script> tag.

<script src="https://unpkg.com/[email protected]"></script>
<script>
  const html = FmAst2Html.renderToHtml(
    '{"type":"paragraph","children":[{"type":"text","value":"Hello"}]}',
  );
  // "<p>Hello</p>\n"
</script>

The script adds one global object, FmAst2Html.

FmAst2Html.renderToHtml(ast)

ast is the AST as a JSON string, or as an object. The function returns the HTML as a string. It does not return a promise.

The function throws when ast cannot be read as an AST. For example, it throws for a string that is not JSON. A node of an unknown type is not an error. Only its children are rendered.

The HTML holds the raw HTML of the Markdown as it is. Do not render the AST of Markdown that you do not trust.

Changes from 0.1

Versions 0.1.x were written in TypeScript. From 0.6.0, the package is built from Rust.

• The second argument of renderToHtml, the options for wikilinks and hashtags, is removed.
• The ES module build, the CommonJS build, and the TypeScript types are removed.
• The types of the AST are not exported. They are in the npm package flatmarkdown-ast.
• The file is about 240KB. It was about 4KB.

Build

You need Rust with the target wasm32-unknown-unknown, wasm-pack, and Node.js.

rustup target add wasm32-unknown-unknown
cargo install wasm-pack --locked

Run these in this folder.

npm run build
npm test

npm run build writes dist/index.global.js. npm test runs that file in Node.js, as a page would run it. Build before you test.

The package has no npm dependencies. You do not need npm install.

License

MIT