Giter Club home page Giter Club logo

hugo-mod-mermaid's Introduction

hugo-mod-mermaid

Render Mermaid diagrams in Markdown content.

Mermaid is a open source Javascript library by Knut Sveidqvist and many contributors. This module retrieves the library on demand from the CDN jsdelivr.com.

Syntax

The module provides a code block render hook for the identifier mermaid. We can copy our Mermaid code into this Markdown block:

‍```mermaid
flowchart TB
A[Fenced code] -->|render-hook| B[Tagged code]
B -->|Mermaid| C(Diagram)
‍```

Configuration

We can initialize the Mermaid module globally in the file data/hugoModMermaid.json with all available configuration parameters.

If we want to change the configuration for a specific diagram we need to use the preamble with the same JSON syntax enclosed in %%.

Layout

For examples run hugo server in the folder exampleSite.

hugo-mod-mermaid's People

Contributors

bowman2001 avatar

Watchers

 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.