Giter Site home page Giter Site logo

mermaid-diagrams's Introduction

mermaid-diagrams

A simple chrome extension to add support for mermaid syntax in github, bitbucket and Azure DevOps pages.

For example add this to any wiki page or markdown file in github

Example 1

sequenceDiagram
  A->> B: Query
  B->> C: Forward query
  Note right of C: Thinking...
  C->> B: Response
  B->> A: Forward response

Example 2

sequenceDiagram
  A->> B: Query B
  B->> C: Forward query B
  Note right of C: Thinking of B...
  C->> B: Response of B
  B->> A: Forward response of B

This will generate a nice diagram if loaded from github/Azure Devops. The extension will just replace the code block with the generated mermaid diagram.

Instructions to install it

Just click the link above and follow the instructions

From source

  1. Clone the repo
    git clone https://github.com/Redisrupt/mermaid-diagrams
  2. Enable developer mode in chrome://extensions
  3. Click on load unpacked extension
  4. Select the extensions folder inside the recently cloned repo

Done!

Navigate to any page in github or Azure DevOps with mermaid syntax blocks to see the extension in action

mermaid-diagrams's People

Contributors

royriojas avatar junsu0ms avatar romain-gilliotte avatar set0gut1 avatar harlantwood avatar gingermusketeer avatar martin-orona avatar

Watchers

James Cloos avatar  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.