README.md

May 25, 2025 · View on GitHub

Syb-mindmap

Description
Installation
- Plugins
  - VSCode
    - Using VSCode Marketplace
    - Using Command Line
  - Intellij IDEA
    - Using JetBrains Marketplace
Usage
- YAML format
- Json format
Contributors
License
Copyright

Description

Syb-mindmap is a lightweight tool that generates mindmap diagrams directly from YAML or JSON files.
It allows developers and teams to define structured maps as code, making diagrams versionable, automatisable, and easily maintainable.

Installation

Plugins

VSCode

Using VSCode Marketplace

Open the Extensions view (Ctrl+Shift+X or Cmd+Shift+X on macOS).
Search for "Syb Mindmap" in the Extensions Marketplace.
Click on the "Install" button.

Using Command Line

code --install-extension sybernatus.syb-mindmap --force

Open the mindmap view

Open the command palette (Ctrl + Shift + P) and type "Syb Mindmap" to generate a mindmap from the current file.

Intellij IDEA

Using JetBrains Marketplace

Open the Plugins view.
Search for "Syb Mindmap" in the JetBrains Marketplace.
Click on the "Install" button.
After installation, the panel will be available in the right sidebar.

Usage

YAML format

$schema: https://raw.githubusercontent.com/sybernatus/syb-mindmap/main/assets/schemas/mindmap.schema.yaml
data:
  text: My Mindmap
  children:
    - text: My first element
      children:
        - text: View my topic

Json format

{
  "$schema": "https://raw.githubusercontent.com/sybernatus/syb-mindmap/main/assets/schemas/mindmap.schema.yaml",
  "data": {
    "text": "My Mindmap",
    "children": [
      {
        "text": "My first element",
        "children": [
          {
            "text": "View my topic"
          }
        ]
      }
    ]
  }

}

Contributors

License

This project is licensed under the Apache License Version 2.0. See LICENSE for details.