arguablykomodo/deno_rusty_markdown

Deno bindings for pulldown-cmark, a CommonMark-compliant Markdown parser made in Rust, compiled to WebAssembly.

rusty_markdown

Deno bindings for pulldown-cmark, a CommonMark-compliant Markdown parser made in Rust, compiled to WebAssembly.

Example

import { html, tokens } from "https://deno.land/x/rusty_markdown/mod.ts";

const tokenized = tokens("~~Goodbye~~ Hello **World**!", { strikethrough: true }));
console.log(tokenized);
// [
//   { type: "start", tag: "paragraph" },
//   { type: "start", tag: "strikethrough" },
//   { type: "text", content: "Goodbye" },
//   { type: "end", tag: "strikethrough" },
//   { type: "text", content: " Hello " },
//   { type: "start", tag: "strong" },
//   { type: "text", content: "World" },
//   { type: "end", tag: "strong" },
//   { type: "text", content: "!" },
//   { type: "end", tag: "paragraph" }
// ]

const rendered = html(tokenized);
console.log(html);
// <p><del>Goodbye</del> Hello <strong>World</strong>!</p>

Repo Structure

The files in the wasm directory are generated by build.ts, and contain the webassembly code, compressed and encoded into base64, alongside boilerplate js generated by wasm-bindgen for interacting with it. If you want to build it yourself, you will need to make sure you have wasm-bindgen-cli installed, and you are using the same version as the one in Cargo.toml.

deno_rusty_markdown's Issues

Foot note and check mark not working

The testing markdown is like this:

#Asdf

asdsaf\`asdf\`asdf[^1]
[x] asdf
[ ] asdf
[^1]: This is a footnote content.

However, it gives out text tokens instead of footnoteReference or taskListMarker.
Does the underlying rust library really support foot note or task list mark ?

Option to prevent escaping within code blocks?

Currently, my less than/greater than symbols and quotes within code blocks are being escaped by this module.

[Documentation] Could there be an explanation of token types a bit ?

They are mostly self-explanatory, but I cannot see it clearly what is a softBreak, hardBreak, or Rule, and when they will be inserted to the token array.

Could there be some explanation of that ?