Git Product home page Git Product logo

honkit-plugin-mermaid-md-adoc's Introduction

Mermaid plugin for HonKit

Plugin for HonKit which renders Mermaid diagrams and flow charts detected in the book markdown and asciidoc.

How to install it?

You can use install via npm:

npm install honkit-plugin-mermaid-md-adoc

And use it for your book with in the book.json:

{
  "plugins": ["mermaid-md-adoc"]
}

How to use it?

Just put the code into fenced code block and tag it mermaid key word like this:

```mermaid
graph
  A --> B;
  A --> C;
  B --> D;
  C --> D;
```

honkit-plugin-mermaid-md-adoc's People

Contributors

rakis avatar chriswessels avatar themightychris avatar clueprints avatar jpreynat avatar xbajci avatar ybougo avatar

Stargazers

wuxingzhong avatar

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.