@keadex/docusaurus-plugin-mina
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

Keadex Mina React Logo

GitHub GitHub package.json version (subfolder of monorepo) NPM Version

Quick Overview

This Docusaurus plugin injects Webpack configurations to include into Docusaurus pages interactive C4 Model diagrams created with Keadex Mina through the Mina React component.

Keadex Mina Docusaurus plugin demo

Usage

Install

yarn add @keadex/docusaurus-plugin-mina # or npm install @keadex/docusaurus-plugin-mina
yarn add @keadex/mina-react # or npm install @keadex/mina-react

Add the plugin

docusaurus.config.js

const config = {
  // your Docusaurus config
  plugins: ['@keadex/docusaurus-plugin-mina']
}

export default config

Include the diagram into MDX files

my-mina-diagram.mdx

---
sidebar_position: 1
---

# My Mina Diagram

import MinaReact from '@keadex/mina-react'

<div style={{height: '50rem'}}>
  <MinaReact
    projectRootUrl="https://raw.githubusercontent.com/keadex/keadex/main/examples/mina-react-example/demo_mina_project/Mina%20Demo"
    diagramUrl="https://raw.githubusercontent.com/keadex/keadex/main/examples/mina-react-example/demo_mina_project/Mina%20Demo/diagrams/system-context/demo-diagram"
  />
</div>

Package Sidebar

Install

npm i @keadex/docusaurus-plugin-mina

Homepage

keadex.dev

Version

1.0.1

License

MIT

Unpacked Size

17.5 kB

Total Files

7

Last publish

Collaborators

  • keadex