MarkXMind

🎉 @markxmind/markxmind-core — the MarkXMind (XMindMark) parser — is now published on npm. Use it in any Node.js or browser project: npm install @markxmind/markxmind-core.

MarkXMind is an online mind mapping editor that creates mind maps using a Markdown-like syntax (XMindMark), with real-time preview and export to multiple formats. Inspired by Markmap and XMindMark.

✨ Features

• 🚀 Create complex mind maps with pure text, using simple XMindMark syntax
• 👀 Real-time preview of rendered results
• 💾 Export to multiple formats: .xmind, .xmindmark, .svg, .png
• 📤 Import .xmind files and convert to XMindMark text
• 🖥️ Runs entirely in the browser, no backend services required
• 🌓 Support for light/dark mode

🔗 Online Usage

👉 Try MarkXMind now

🚀 Local Development

Prerequisites

• Node.js (v18 or above)
• npm

Installation Steps

1. Clone the repository

git clone https://github.com/jinzcdev/markxmind.git
cd markxmind

2. Install dependencies

npm install

3. Start the development server

npm run serve

4. Open your browser and visit http://localhost:5173

Build the Project

npm run build

📝 How to Use

Basic Usage

1. Enter XMindMark text in the editor
2. Preview the generated mind map in real-time on the right
3. Use the toolbar at the bottom to export to different formats

XMindMark Syntax Introduction

XMindMark syntax is similar to Markdown, using indentation and special symbols to represent the hierarchical structure and relationships of elements in the mind map.

Basic Syntax Example

Central Topic

- Topic 1
    * Subtopic 1.1
    * Subtopic 1.2
- Topic 2
    * Subtopic 2.1
        - Subsubtopic 2.1.1

Advanced Syntax

• Relationships: Use [number] and [^number] to create connections between topics
• Boundaries: Use [B] or [Bnumber] to create boundaries
• Summaries: Use [S] or [Snumber] to create summaries
• Hyperlinks: Use [L:url] to add hyperlinks to topics
• Notes: Use [N:content] to add text notes to topics
• Folding: Use [F] to make topics appear folded

For detailed syntax, please refer to:

• XMindMark Syntax Guide
• XMindMark Detailed Specification

🤝 Contributions

Contributions are welcome, whether it's code contributions, bug reports, or new feature suggestions! Please participate through GitHub Issues and Pull Requests.

📄 License

MIT