Gatsby-remark-graphviz NPM | npm.io

5.14.0 • Published 7 months ago

Install

Weekly downloads

405

License

MIT

Repository

Last release

7 months ago

gatsby-remark-graphviz

Processes graphviz (dot and circo) code blocks in your markdown files and replaces them with the rendered SVG using viz.js

demo gif

Install

npm install gatsby-remark-graphviz

Note that you do not need graphviz installed on your machine as this project depends on viz.js which is a pure JavaScript port of graphviz.

How to use

// In your gatsby-config.js
plugins: [
  {
    resolve: 'gatsby-transformer-remark',
    options: {
      plugins: [
        'gatsby-remark-graphviz',
        // place before other plugins that modify code blocks (such as prismjs)
        // 'gatsby-remark-prismjs',
      ]
    }
  }
],

Then, add dot code blocks to your markdown. E.g

```dot
digraph graphname {
  a -> b;
  b -> c;
  a -> c;
}
```

Which will be rendered using viz.js and the output html will replace the code block with the actual SVG.

rendered-graph

Custom attributes can be passed to the rendered SVG:

```dot id="my-id" class="my-class"
digraph graphname {
  a -> b;
  b -> c;
  a -> c;
}
```

By default, the following inline style is applied to all rendered SVGs in order to make them responsive:

max-width: 100%;
height: auto;

This can be overwritten by using the custom attributes feature:

```dot style=""
digraph graphname {
  a -> b;
  b -> c;
  a -> c;
}
```

Caveats

In your gatsby-config.js, make sure you place this plugin before other remark plugins that modify code blocks (like prism).

Alternatives

If you want a broader range of drawing options, checkout gatsby-remark-draw. It provides SvgBobRus, Graphviz, and Mermaid, but note that you must have these already installed on your system

If you're simply looking for a normal (not Gatsby) remark plugin for graphviz, see remark-graphviz which inspired this plugin.

gatsby gatsby-plugin markdown remark graphviz dot circo graphs

@babel/runtime cheerio unist-util-visit viz.js

@everything-registry/sub-chunk-1723 @divramod/gatsby-theme-ts-mdx @hpprc/gatsby-theme-blog @gatsbyjs/gatsby-theme-website @zalastax/nolb-gatsby-r gatsby-markbook gatsby-theme-gatsbyjs-website

5.11.2-canary-less-lmdb.0

7 months ago

9 months ago

9 months ago

11 months ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

2 years ago

2 years ago

3 years ago

3 years ago

5.0.0-alpha-drupal-proxyurl.14

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

5.0.0-alpha-v5.d20221005t111511.35

3 years ago

3 years ago

3 years ago

3 years ago

5.0.0-alpha-v5.d20221012t101120.57

3 years ago

5.0.0-alpha-v5.d20221010t183635.51

3 years ago

5.0.0-alpha-v5.d20221007t081809.41

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4.14.0-alpha-transformer-json.26

3 years ago

4.23.0-alpha-v5.26

3 years ago

3 years ago

5.0.0-alpha-v5.16

3 years ago

4.23.0-alpha-preview-gh-api.26

3 years ago

3 years ago

5.0.0-alpha-v5.25

3 years ago

5.0.0-alpha-v5.24

3 years ago

5.0.0-alpha-v5.26

3 years ago

4.23.0-alpha-9689ff.25

3 years ago

3 years ago

4.23.0-alpha-a5-peer.70

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4.15.0-alpha-wp-image-cdn-auth.48

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4.18.0-alpha-drupal-self-reference.18

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

3 years ago

3 years ago

4.8.0-alpha-image-service.25

3 years ago

4.8.0-alpha-image-service.24

3 years ago

3 years ago

4.6.0-alpha-ts-jit.60

4 years ago

4 years ago

4 years ago

4 years ago

3 years ago

4.7.0-alpha-image-service.75

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4.0.0-zz-next.2

4 years ago

4 years ago

4.0.0-zz-next.1

4 years ago

4.0.0-zz-next.8

4 years ago

3.11.0-alpha-qe-sm.46

4 years ago

4 years ago

4 years ago

4.0.0-alpha-9689ff.13

4 years ago

4.0.0-alpha-9689ff.36

4 years ago

4.0.0-alpha-9689ff.34

4 years ago

4.0.0-alpha-9689ff.8

4 years ago

4.0.0-alpha-9689ff.24

4 years ago

4.0.0-alpha-9689ff.22

4 years ago

4.0.0-alpha-9689ff.17

4 years ago

4 years ago

4 years ago

4.0.0-alpha-9689ff.5

4 years ago

4 years ago

4 years ago

4.0.0-alpha-9689ff.27

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

2.0.0-alpha-remark13.167

4 years ago

4 years ago

4 years ago

4 years ago

2.0.0-alpha-remark13.165

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

1.5.0-image-helpers.58

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

1.2.3-unifiedroutes.76

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

1.1.8-otp-test.31

6 years ago

1.1.8-otp-test.30

6 years ago

1.1.8-otp-test.29

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago