Git Product home page Git Product logo

gatsby-remark-graph's Introduction

gatsby-remark-graph

Greenkeeper badge

Travis Status

Make nice graphs in your markdown files in gatsbyjs, using mermaid.

Here is a basic demo, which also uses my starter template.

install

npm install --save gatsby-transformer-remark gatsby-remark-graph

How to use

// In your gatsby-config.js
plugins: [
  {
    resolve: 'gatsby-transformer-remark',
    options: {
      plugins: [
        {
          resolve: 'gatsby-remark-graph',
          options: {
            // this is the language in your code-block that triggers mermaid parsing
            language: 'mermaid', // default
            theme: 'default' // could also be dark, forest, or neutral
          }
        }
      ]
    }
  }
]

Make sure you put it before other plugins (especially those that work with code blocks, like prism.)

Usage in Markdown

```mermaid
graph LR
    A[Square Rect] -- Link text --> B((Circle))
    A --> C(Round Rect)
    B --> D{Rhombus}
    C --> D
```

Will give you a graph that looks like this:

diagram

gatsby-remark-graph's People

Contributors

ajrussellaudio avatar greenkeeper[bot] avatar jamestharpe avatar joewood avatar konsumer avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

gatsby-remark-graph's Issues

Clickable nodes not styled

I am working with this plugin on a new project, and my diagram is getting pretty complex. I wanted to break it up into multiple diagrams and use the click nodeId url syntax to link between them. However, it seems that the clickable class is not added to my node. This means my cursor does not become 'pointer'.

Example diagram:

graph LR

one --> two
click two "https://two.com"

In the mermaid live editor:
image

In gatsby:
image

Gatsby build is failing because of remark-graph

Gastby version :1.9.238

error Generating JavaScript bundles failed
error Cannot read property 'render' of undefined


  TypeError: Cannot read property 'render' of undefined

  - errors.js:37 PrettyError.prettyError.render
    [chronicle]/[gatsby]/[gatsby-cli]/lib/reporter/errors.js:37:28

  - index.js:69 ConsoleReporter.error
    [chronicle]/[gatsby]/[gatsby-cli]/lib/reporter/index.js:69:43

  - index.js:54 ConsoleReporter.panic
    [chronicle]/[gatsby]/[gatsby-cli]/lib/reporter/index.js:54:16

  - build.js:23 reportFailure
    [chronicle]/[gatsby]/dist/commands/build.js:23:10

  - build.js:65
    [chronicle]/[gatsby]/dist/commands/build.js:65:15

  - next_tick.js:112 process._tickCallback
    internal/process/next_tick.js:112:11

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.