femark

A blazingly fast markdown to html parser and syntax highlighter built using the pulldown-cmark and tree-sitter-highlight crate natively. PRs are welcome. Very much a WIP

Install

cargo add femark

Use

The package exposes two functions that will process your markdown and compile it to HTML. It will also generate a table of contents for you with your heading tags and their respective level. If you have no headings, toc should will be None, but if there is an error parsing your markdown, it will throw an error.

It is recomended to run this on the server, since it has a fairly large package size.

use femark::{HTMLOutput, process_markdown_to_html, process_markdown_to_html_with_frontmatter};

let input: &str = "# Hello World!";
// Processes Markdown without looking for frontmatter
let HTMLOutput{content, toc,  ..} = process_markdown_to_html(input);
// This one will try to find frontmatter, and is otherwise identica
let HTMLOutput{content, toc, frontmatter, ..} = process_markdown_to_html_with_frontmatter(input, true));

println!("Title: {}", frontmatter.title.unwrap());

Supported Languages

• Rust
• Rsx/Rstml
• Typescript
• Tsx
• Javascript
• Jsx
• Dockerfile
• Python
• Nix
• Go
• C
• HTML
• TOML
• JSON

The currently supported languages are mostly driven by my needs, but if you have requests, feel free to submit a PR or an Issue for any you'd like to have, and I'll review them.

Frontmatter

Frontmatter can be included in your Markdown, in a specific format. At the start of the document, an optional H1 can be included for the title, and a code block containing your frontmatter would come next.

# Title of My Awesome Post
```toml
    author: "benwis"
    mantra: "It depends"
```

This is where markdown file content would go.

The H1 will still be rendered in the output, but the codeblock for the frontmatter will be removed by femark and not included in the outputted HTML.

Theme

By default, this package does not style your code blocks, merely decorates the elements with classes that range from hh0 to hh20. The indices refer to the elements in this list:

let highlight_names = [
      "attribute",
      "constant",
      "function.builtin",
      "function",
      "keyword",
      "operator",
      "property",
      "punctuation",
      "punctuation.bracket",
      "punctuation.delimiter",
      "string",
      "string.special",
      "tag",
      "type",
      "type.builtin",
      "variable",
      "variable.builtin",
      "variable.parameter",
      "comment",
      "macro",
      "label",
    ]

For example, hh0 would refer to an attribute and hh20 would be a label. You'll want to add some css classes for each attribute. Because this is a common tree-sitter theme, if you search for neovim themes that support tree-sitter, you can find items like TSFunction and TSAttribute with examples. A basic theme is provided below:

.hh4 {
  color: purple;
}

.hh3 {
  color: blue;
}

.hh13 {
  color: pink;
}

.hh10 {
  color: green;
}

.hh5 {
  color: gray;
}

.hh18 {
  color: lightgray;
}