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

@dendronhq/remark-mermaid

v0.4.0

Published

A remark plugin for Markdown that replaces `mermaid` graphs with rendered SVGs.

Downloads

904

Readme

remark-mermaid

NPM Travis CI MIT License

Replaces fenced code blocks in mermaid format with:

  • Links to rendered SVG files of the graph (default mode).
  • Mermaid-formatted code wrapped in div tags for rendering by mermaidjs (simple mode).

You might also like remark-graphviz.

Installation

$ npm install remark-mermaid mermaid.cli

Usage

Graphs defined using mermaid can be referenced using a mermaid: title which will generate an SVG image.

[Link to a Graph](test/fixtures/assets/example.mmd "mermaid:")
![Embed image of graph](test/fixtures/assets/example.mdd "mermaid:")

Alternatively, graphs can be generated inline, by using mermaid as the language identifier for a fenced code block.

See this project's fixtures for more examples.

Options

  • simple: when set to true, plugin will wrap mermaid graphs in an <div class="mermaid"> element instead of generating an SVG. Defaults to false.

Example

SVG Generation

Given a file, example.md, which contains the following Markdown:

Using remark like follows:

var vfile = require('to-vfile');
var remark = require('remark');
var mermaid = require('remark-mermaid');

var example = vfile.readSync('example.md');

remark()
  .use(mermaid)
  .process(example, function (err, file) {
    if (err) throw err;
    console.log(String(file));
  });

Will result in an SVG being written relative to example.md, and the Markdown being transformed to:

# mermaid code block

![](./6b03e143dc2a47a93496133d692c44d5ec012b57.svg "`mermaid` image")

To change where the SVG's are written, set data.destinationDir on the vFile:

var vfile = require('to-vfile');
var remark = require('remark');
var mermaid = require('remark-mermaid');

var example = vfile.readSync('example.md');
example.data = {
  destinationDir: '~/absolute/path/to/output'
};

remark()
  .use(mermaid)
  .process(example, function (err, file) {
    if (err) throw err;
    vfile.writeSync({ path: example.destinationFilePath });
  });

This allows you process files from one directory, and save the results to another.

Simple mode

The following code sample enables simple mode:

var vfile = require('to-vfile');
var remark = require('remark');
var mermaid = require('remark-mermaid');

var example = vfile.readSync('example.md');

remark()
  .use(mermaid, { simple: true })
  .process(example, function (err, file) {
    if (err) throw err;
    console.log(String(file));
  });

This will result in the following Markdown output:

# mermaid code block

<div class="mermaid">
  graph LR
    Start --> Stop
</div>

mermaidjs