axton-obsidian-visual-skills  by axtonliu

Text-to-diagram generation for Obsidian

Created 2 weeks ago

New!

1,011 stars

Top 36.9% on SourcePulse

GitHubView on GitHub
Project Summary

This project provides a set of "skills" for Claude Code, enabling users to automatically generate visual diagrams—specifically Excalidraw, Mermaid, and Obsidian Canvas files—directly from text descriptions within Obsidian. It targets Obsidian users, researchers, and developers seeking an efficient way to translate textual information into structured visual representations, thereby enhancing knowledge management and documentation workflows.

How It Works

The core mechanism leverages Claude Code's "skills" feature, which allows prompt-based extensions for specialized capabilities. These skills are implemented as simple markdown files that Claude Code loads on demand. When a user requests a visualization using specific trigger words, the relevant skill processes the input text to generate the corresponding diagram format (Excalidraw JSON, Mermaid syntax, or Obsidian Canvas JSON). This approach offers a more accessible alternative to complex server-based integrations, focusing on demonstrating how AI models can be augmented with practical, output-specific functionalities.

Quick Start & Requirements

  • Prerequisites: Claude Code CLI installed; Obsidian with the Excalidraw plugin.
  • Installation: Clone the repository (git clone https://github.com/axtonliu/axton-obsidian-visual-skills.git) and copy the skill folders (excalidraw-diagram, mermaid-visualizer, obsidian-canvas-creator) into your Claude Code skills directory (e.g., ~/.claude/skills/).
  • Usage: Trigger skills via Claude Code prompts, e.g., "Create an Excalidraw flowchart showing the CI/CD pipeline" or "把这个工作流程转成 Mermaid 图表".
  • Links: Repository: https://github.com/axtonliu/axton-obsidian-visual-skills

Highlighted Details

  • Excalidraw Diagram Generator: Creates .md files with embedded Excalidraw JSON, supporting a hand-drawn aesthetic, full Chinese text, and various diagram types (Flowchart, Mind Map, Hierarchy, etc.).
  • Mermaid Visualizer: Transforms text into professional Mermaid diagrams with built-in syntax error prevention. Supports diverse types like Process Flow, Sequence, and State diagrams, with configurable layouts and color schemes compatible with Obsidian and GitHub.
  • Obsidian Canvas Creator: Generates interactive .canvas files using MindMap or Freeform layouts. Features smart node sizing, automatic edge creation, color-coded nodes, and overlap prevention algorithms.

Maintenance & Community

This project is described as an "Experimental" public prototype. The author's primary focus is demonstrating how tools and systems integrate, rather than active codebase maintenance. Contributions, including bug reports with reproducible cases and feature suggestions, are welcome. The author, Axton Liu, can be found at axtonliu.ai, YouTube (@AxtonLiu), and Twitter/X (@axtonliu).

Licensing & Compatibility

The project is released under the MIT License. This permissive license generally allows for commercial use and integration into closed-source projects without significant restrictions.

Limitations & Caveats

The project is explicitly labeled as "Experimental" and a "public prototype." It does not yet cover all input scales or edge cases, and output quality can vary depending on the AI model version and input structure. Users encountering issues are encouraged to submit reproducible cases, as the primary focus is on demonstrating system integration rather than ongoing maintenance.

Health Check
Last Commit

1 week ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
3
Star History
1,016 stars in the last 17 days

Explore Similar Projects

Feedback? Help us improve.