Code Monkey home page Code Monkey logo

astro-mermaidjs's Introduction

Temporary alternative for https://www.npmjs.com/package/astro-diagram (which needs fixes merged)

Enables using MermaidJS diagrams inline in .md(x) files in Astro. Utilizing Playwright during build time, the HTML for diagrams is generated, and the snippets replaced.

Installation

npm install astro-mermaidjs

yarn install astro-mermaidjs

pnpm install astro-mermaidjs

Usage

In your astro.config.{ts,mjs}:

import remarkMermaid from 'astro-mermaidjs/remark-mermaid';
// ...

export default defineConfig({
  // ...
  markdown: {
    remarkPlugins: [
      // ...
      remarkMermaid,
    ],
  },
  // ...
});

Then in .md(x) files, use the regular mermaid DSL like you would on Github or other mermaid-supporting markdown flavors:

```mermaid
sequenceDiagram
    Client-->Server: ping
    Server-->Client: pong
```

astro-mermaidjs's People

Contributors

yonifeng 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.