goxmind

Read this document in other languages:

• 简体中文 (Chinese)

goxmind is a library written in Go, designed for creating, manipulating, and saving mind map files in the XMind format. It simplifies the process of constructing mind map structures and saving them as standard XMind files.

Features

• Mind Map Structure Creation: Supports creating XMind files, adding sheets, root nodes, and child nodes.
• Node Attribute Settings: Allows adding icons, notes, and links to nodes.
• JSON File Loading: Enables generating XMind files based on predefined JSON structures.

Compatibility

• Supported XMind Versions: Tested and compatible with XMind 8 and XMind (2025). If you need support for other versions, please contact me.

Installation Guide

Environment Requirements

• Go programming environment (version 1.18 or higher is recommended).

Installation Steps

You can add the following reference to your go.mod file:

go get github.com/vivian0517/goxmind

Usage

Example Code

package main

import "github.com/vivian0517/goxmind"

func main() {
	// Initialize
	xmind := goxmind.New()
	// Add sheet title and root node title
	rootNode := xmind.AddSheet("Sheet title", "Root Node title")

	// Add child node title
	child1 := rootNode.AddNode("Child 1") // If you want to add more nodes under this node, you need to save the return value
	rootNode.AddNode("Child 2")           // If you don't want to add more nodes under this node, you can ignore the return value
	rootNode.AddNode("Child 3")
	rootNode.AddNode("Child 4")

	// Continue adding child nodes under the child1 node
	child1_1 := child1.AddNode("Child 1.1") // If you want to add more nodes under this node, you need to save the return value
	child1_2 := child1.AddNode("Child 1.2")
	child1.AddNode("Child 1.3") // If you don't want to add more nodes under this node, you can ignore the return value

	// Continue adding child nodes under the child1.1 node
	child1_1.AddNode("Child 1.1.1")
	child1_1.AddNode("Child 1.1.2")
	child1_2.AddNode("Child 1.2.1")
	child1_2.AddNode("Child 1.2.2")

	// Save xmind, the ".xmind" file suffix is optional
	xmind.Save("xmind_file_name")
}

Running the Example

Save the above code as main.go, then run the following command in the terminal:

go run main.go

Result

After running the example, you will find a file named xmind_file_name.xmind in the same directory. This file is the generated XMind file.

Features

1.add notes/add marker/add herf

package main

import "github.com/vivian0517/goxmind"

func main() {
	// Initialize
	xmind := goxmind.New()
	// Add sheet title and root node title
	rootNode := xmind.AddSheet("Sheet title", "Root Node title")

	// Add child node title
	child1 := rootNode.AddNode("Child 1") // If you want to add icons, hyperlinks, etc. to this node, you need to save the return value
	// Set hyperlink for child1 node
	child1.AddHref("www.example.com")

	child2 := rootNode.AddNode("Child 2")
	// Set notes for child2 node
	child2.AddNotes("Notes")

	child3 := rootNode.AddNode("Child 3")
	// Set icon for child3 node 🔢 Priority
	child3.AddMarker(goxmind.Priority1)
	child3.AddMarker(goxmind.Priority2)

	child4 := rootNode.AddNode("Child 4")
	// Set icon for child4 node ⭐ Star
	child4.AddMarker(goxmind.StarRed)
	// Set icon for child4 node 😊 Smiley
	child4.AddMarker(goxmind.SmileySmile)
	// Set icon for child4 node ✅ Task Progress
	child4.AddMarker(goxmind.Task0_8)
	// For more icons, refer to the MarkerId constant in marker.go

	// Save xmind, the ".xmind" file suffix is optional
	xmind.Save("xmind_file_name")
}

2.Parse the JSON file from the specified path and generate an XMind file with the specified filename

package main

import "github.com/vivian0517/goxmind"

func main() {

    // Create a jsondata.txt file in the project path, 
    // PraseJsonSaveXmind can read the txt and generate an XMind file with the specified filename. 
    // The JSON structure example is as follows:

    goxmind.PraseJsonSaveXmind("xmind_file_name")
}

JSON structure example:

{
  "filename": "xmind_file_name.xmind",
  "sheet": [
    {
      "sheetTitle": "Sheet title",
      "node": {
        "nodeTitle": "Root Node title",
        "children": [
          {
            "nodeTitle": "Child 1",
            "children": [
              {
                "nodeTitle": "Child 1.1",
                "children": [
                  {
                    "nodeTitle": "Child 1.1.1"
                  },
                  {
                    "nodeTitle": "Child 1.1.2"
                  }
                ]
              },
              {
                "nodeTitle": "Child 1.2",
                "children": [
                  {
                    "nodeTitle": "Child 1.2.1"
                  },
                  {
                    "nodeTitle": "Child 1.2.2"
                  }
                ]
              },
              {
                "nodeTitle": "Child 1.3"
              }
            ]
          },
          {
            "nodeTitle": "Child 2"
          },
          {
            "nodeTitle": "Child 3"
          },
          {
            "nodeTitle": "Child 4"
          }
        ]
      }
    }
  ]
}

3.Load the specified XMind file, compatible with new and old versions, print/save JSON structure

package main

import (
    "fmt"
    "github.com/vivian0517/goxmind"
)

func main() {

	// Load the specified XMind file, compatible with both old and new versions
	xmind, err := goxmind.Load("xmind_file_name")
	if err != nil {
	  fmt.Print("err:", err)
	}

	// Print the JSON structure
	xmind.PrintJson()

	// Save the JSON structure
	xmind.SaveJson("save.txt")
	// Delete node
	xmind.DeleteNode(xmind.Sheets[0].Node.Children[0])
	// Add node before node
	xmind.AddNodeBefore(xmind.Sheets[0].Node.Children[0], "new node before")
	xmind.Save("filename")
}

Contribution Guide

If you wish to contribute to the goxmind project, please follow these steps:

1. Fork this repository.
2. Create your feature branch (git checkout -b feature/AmazingFeature).
3. Commit your changes (git commit -m 'Add some AmazingFeature').
4. Push the changes to the branch (git push origin feature/AmazingFeature).
5. Open a Pull Request.

License

This project is licensed under the MIT License.

Contact

If you have any questions or suggestions, please submit an issue in the GitHub repository.