npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

syzoj-renderer

v1.2.5

Published

SYZOJ's renderer for markdown, math and highlight

Downloads

107

Readme

syzoj-renderer

SYZOJ's renderer for markdown, math and highlight.

Example

let { markdown, highlight } = require('syzoj-renderer');

console.log(await markdown(text));
console.log(await highlight(code, language));

API

async markdown(text, [cache, filterFunction, options])

text is the Markdown text to be rendered.

cache is null or a object with two functions to manipulate a Key-Value store (key is hashed before passing to cache):

  • async get(string key)
  • async set(string key, string value)

filterFunction(html) is a function to filter rendered HTML. It can be used to prevent XSS attack. Should return filtered HTML.

options is a object, may contain:

  • markdownIt: Overrides default options in new MarkdownIt(options). (See markdown-it)
  • markdownItMath: Overrides default options in markdownIt.use(MathdownItMath, options). (See markdown-it-math-loose)
  • markdownItMergeCells: Set to false to disable markdown-it-merge-cells in markdown tables, which will merge adjacent cells with same content in tables
  • highlight: Same as highlight's options parameter, used when highlighting code in markdown.

Return rendered HTML. Won't throw.

async highlight(code, language[, cache, options])

Highlight some code with syntect.

code is the code to be highlighted. language is code's language.

cache is same as the parameter in markdown().

options is a object, may contain:

  • highlighter: Pass a function async function (code, language) to replace the defualt highlighter.
  • wrapper: An array [before, after]. Highlighted code's HTML will be wrapped by before and after. Defaults to ['<pre><code>', '</code></pre>'].

Return highlighted code in HTML. Won't throw.

Notes

  • Markdown backend is markdown-it.
    • GFM is supported.
    • By default, linkify and html are enabled, typographer and breaks are disabled.
  • By default, code highlight's backend is syntect.
    • A theme CSS is required to display highlighted code properly. See syntect-js's Usage. The default prefix is hl-.
  • Math backend is MathJax 3.
    • Maths with spaces within dollar sign like $ a+b $ will work.
    • Complex maths like $ \sum\limits_{i=0}^na_i $ won't be broken by Markdown.
    • To ensure each document's math rendering state isolated, \require is disabled.
    • Maths that failed to render would result in displaying error message.