https://github.com/McKean/diagon.nvim

Use Diagon within neovim and retain the instructions so they can be modified
https://github.com/McKean/diagon.nvim

Last synced: about 2 months ago
JSON representation

Use Diagon within neovim and retain the instructions so they can be modified

• Host: GitHub
• URL: https://github.com/McKean/diagon.nvim
• Owner: McKean
• License: mit
• Created: 2024-03-16T22:59:03.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-05-23T08:27:07.000Z (8 months ago)
• Last Synced: 2024-08-01T18:24:17.770Z (5 months ago)
• Language: Lua
• Homepage:
• Size: 3.91 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• my-neovim-pluginlist - McKean/diagon.nvim - commit/McKean/diagon.nvim)  (New features / Diagram)

README

        
# diagon.nvim

Use [Diagon](https://github.com/ArthurSonzogni/Diagon) within neovim 

and retain the instructions so they can be modified.

[![asciicast](https://asciinema.org/a/fU8ga9yFMXVSdECZf7zgO9m16.svg)](https://asciinema.org/a/fU8ga9yFMXVSdECZf7zgO9m16)

## Installation

Make sure you have Diagon installed:

https://github.com/ArthurSonzogni/Diagon

Use your favorite plugin manager to install diagon.nvim

For Lazy add something like this:

```

  {

    "mckean/diagon.nvim",

    config = function()

      require("diagon")

    end,

  },

```

### Usage

Currently the following generators are supported

* Sequence Diagram

* Mathematic Expression

Providing a name is optional but encouraged, especially when 

using multiple entries in a single document.

The command `Diagon` will generate the diagram and insert it after the code block.

Once placed it can be put anywhere and subsequent calls will update the diagram.

#### Sequence Diagram

````

```sequence name

hello -> world: hi!

world -> peace: jey!

```

````

```

```

#### Math Expression

````

```math name

1+1/2 + sum(i,0,10) = 113/2

```

````

```

```