XMindMark

https://github.com/xmindltd/xmindmark
Admin
XMindMark is a lightweight markup language for mind mapping inspired by markdown that converts text...
Tokens:5,900
Snippets:80
Trust Score:8.5
License:MIT
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install xmindmark CLI

Source: https://github.com/xmindltd/xmindmark/blob/main/README.md

Install the xmindmark command-line interface globally using npm.

```bash
npm install -g xmindmark
```

--------------------------------

### Get CLI Help

Source: https://github.com/xmindltd/xmindmark/blob/main/README.md

Display help information for the xmindmark CLI program.

```bash
xmindmark -h
```

```bash
xmindmark --help
```

--------------------------------

### Install xmindmark Javascript Library

Source: https://github.com/xmindltd/xmindmark/blob/main/README.md

Install the xmindmark library as a dependency for a Node.js project.

```bash
npm install xmindmark -S
```

--------------------------------

### Basic XMindMark Structure

Source: https://github.com/xmindltd/xmindmark/blob/main/README.md

Example of a simple XMindMark file describing seasons.

```xmindmark
Seasons
- Spring
- Summer
- Autumn
- Winter
```

--------------------------------

### Define Boundaries for Topics

Source: https://github.com/xmindltd/xmindmark/blob/main/docs/specification.md

Use `[B<number?>]` after a topic to assign it to a boundary. Topics with the same boundary marker at the same level will be grouped under a single boundary. Boundary titles can be specified on a new line starting with `[B]` or `[B<number>]:` followed by the title.

```xmindmark
* topic 1 [B]
* topic 2 [B]
```

```xmindmark
* topic 1 [B1]
* topic 2 [B1]
```

```xmindmark
- main topic
    * topic 1 [B1]
    * topic 2 [B1]
    * topic 3 [B2]
    * topic 4 [B2]
```

```xmindmark
- main topic
    * topic 1 [B]
    * topic 2 [B]
    [B]: Boundary Title
```

--------------------------------

### Add Main and Sub Topics

Source: https://github.com/xmindltd/xmindmark/blob/main/docs/specification.md

Use '-' or '*' followed by a space to define main topics. Indent further lines with spaces or tabs to create sub-topics. Empty lines between topics of the same level are ignored.

```xmindmark
Central Topic

- Main Topic 1
- Main Topic 2
```

```xmindmark
Central Topic

* Main Topic 1

* Main Topic 2

* Main Topic 3
```

```xmindmark
Central Topic

- Main Topic 1

- Main Topic 2
    * Subtopic 2.1
    * Subtopic 2.2

- Main Topic 3
    * Subtopic 3.1
        - Subtopic 3.1.1
        - Subtopic 3.1.2
    * Subtopic 3.2
```

--------------------------------

### Convert XMindMark to XMind File via Standard Input (CLI)

Source: https://github.com/xmindltd/xmindmark/blob/main/README.md

Pipe XMindMark content through standard input to convert it to an XMind file.

```bash
cat <your-xmindmark-file> | xmindmark
```

--------------------------------

### Manage XMindMark Cache and Version

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Clear cached rendering dependencies or check tool version and help information.

```bash
# Reset all cached data
xmindmark reset

# Get help
xmindmark --help
xmindmark -h

# Check version
xmindmark --version
xmindmark -v
```

--------------------------------

### CLI: Convert XMindMark to XMind

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Converts .xmindmark text files into .xmind binary files.

```APIDOC
## Convert XMindMark to XMind File

### Description
Converts one or more .xmindmark files into the .xmind format. Supports file paths or piping content via stdin.

### Method
CLI Command

### Endpoint
xmindmark [files...]

### Parameters
#### Path Parameters
- **files** (string) - Required - One or more .xmindmark file paths to convert.
```

--------------------------------

### Convert XMind to XMindMark via CLI

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Use the 'from' subcommand to convert existing XMind files into XMindMark format.

```bash
# Convert XMind to XMindMark (output to stdout)
xmindmark from existing.xmind

# Convert and save to file
xmindmark from existing.xmind output.xmindmark

# Redirect stdout to file
xmindmark from existing.xmind > converted.xmindmark
```

--------------------------------

### Convert XMindMark to XMind via CLI

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Use the CLI to convert .xmindmark files to .xmind format. Supports single files, multiple files, and stdin piping.

```bash
# Install globally
npm install -g xmindmark

# Convert single file
xmindmark mymap.xmindmark
# Output: mymap.xmind in current directory

# Convert multiple files
xmindmark map1.xmindmark map2.xmindmark map3.xmindmark

# Pipe content through stdin
cat mymap.xmindmark | xmindmark
echo "Central Topic
- Main 1
- Main 2" | xmindmark
```

--------------------------------

### Define Summaries

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Create summary topics that span multiple items using summary markers.

```xmindmark
Weekly Tasks
- Monday Tasks [S]
- Tuesday Tasks [S]
- Wednesday Tasks [S]
[S]: First Half Summary
    - Review progress
    - Adjust priorities
```

--------------------------------

### Integrate XMindMark in Browser

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Use the UMD build to parse XMindMark content into XMind files directly in the browser.

```html
<!DOCTYPE html>
<html>
<head>
  <title>XMindMark Browser Demo</title>
</head>
<body>
  <textarea id="editor" rows="10" cols="50">
Project Ideas
- Web App
    * Dashboard
    * API
- Mobile App
    * iOS
    * Android
  </textarea>
  <button id="download">Download XMind File</button>

  <script src="node_modules/xmindmark/dist/umd/xmindmark.min.js"></script>
  <script>
    document.getElementById('download').addEventListener('click', async () => {
      const content = document.getElementById('editor').value

      try {
        const arrayBuffer = await xmindmark.parseXMindMarkToXMindFile(content)

        // Create download link
        const blob = new Blob([arrayBuffer], {
          type: 'application/vnd.xmind.workbook'
        })
        const url = URL.createObjectURL(blob)

        const link = document.createElement('a')
        link.href = url
        link.download = 'mindmap.xmind'
        document.body.appendChild(link)
        link.click()
        document.body.removeChild(link)

        URL.revokeObjectURL(url)
      } catch (error) {
        console.error('Conversion failed:', error)
      }
    })
  </script>
</body>
</html>
```

--------------------------------

### Apply Boundaries and Relationships to Summary Topics

Source: https://github.com/xmindltd/xmindmark/blob/main/docs/specification.md

Demonstrates applying boundaries and relationships to summary topics and their sub-topics.

```text
* topic 1 [S]
* topic 2 [S][1]
[S]: Summary Topic[^1]
    - subtopic 1 [B]
    - subtopic 2 [B]
```

--------------------------------

### Convert XMindMark to XMind File (CLI)

Source: https://github.com/xmindltd/xmindmark/blob/main/README.md

Convert an XMindMark file to an XMind file using the CLI. The output .xmind file is generated in the current working directory.

```bash
xmindmark <your-xmindmark-file>
```

--------------------------------

### CLI: Convert XMind to XMindMark

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Converts existing .xmind files back into .xmindmark text format.

```APIDOC
## Convert XMind to XMindMark

### Description
Extracts the structure of an XMind file and converts it into the XMindMark text format.

### Method
CLI Command

### Endpoint
xmindmark from [file]

### Parameters
#### Path Parameters
- **file** (string) - Required - The path to the source .xmind file.
```

--------------------------------

### Apply Multiple Marker Symbols

Source: https://github.com/xmindltd/xmindmark/blob/main/docs/specification.md

Shows how to apply multiple markers to a single topic by placing them immediately after the content.

```text

Seasons of 2021

- Spring [1]
- Summer [B1]
- Autumn [B1][^1](Cool)[S1]
- Winter [S1]
```

--------------------------------

### Specify Output Directory (CLI)

Source: https://github.com/xmindltd/xmindmark/blob/main/README.md

Use the -o or --outputDir flag to specify the directory where the generated mind map file will be saved.

```bash
xmindmark -o ./out <your-xmindmark-file>
```

```bash
xmindmark --outputDir ./out <your-xmindmark-file>
```

--------------------------------

### Convert XMindMark to SVG File (CLI)

Source: https://github.com/xmindltd/xmindmark/blob/main/README.md

Convert an XMindMark file to an SVG file using the -f or --format flag. The output .svg file is generated in the current working directory.

```bash
xmindmark -f svg <your-xmindmark-file>
```

```bash
xmindmark --format svg <your-xmindmark-file>
```

--------------------------------

### Convert XMindMark to SVG via CLI

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Generate SVG images from XMindMark files using the -f or --format flag. Output directories can be specified with -o or --outputDir.

```bash
# Convert to SVG format
xmindmark -f svg mymap.xmindmark
xmindmark --format svg mymap.xmindmark
# Output: mymap.svg in current directory

# Specify output directory
xmindmark -f svg -o ./output mymap.xmindmark
xmindmark --format svg --outputDir ./exports mymap.xmindmark

# Convert multiple files to SVG
xmindmark -f svg -o ./images *.xmindmark
```

--------------------------------

### Create Summary Topics with Sub-topics

Source: https://github.com/xmindltd/xmindmark/blob/main/docs/specification.md

Defines a summary topic structure where the summary topic contains its own sub-topics.

```text
* topic 1 [S]
* topic 2 [S]
[S]: Summary Topic
    - subtopic 1
    - subtopic 2
```

--------------------------------

### Create Relationships Between Topics

Source: https://github.com/xmindltd/xmindmark/blob/main/docs/specification.md

Mark topics with `[<number>]` and `[^<number>]` to establish relationships. The numbers must match for a relationship to be formed. Relationship titles can be added in parentheses after the target marker.

```xmindmark
* To topic [1]
* Topic
    - From topic [^1]
```

```xmindmark
* To topic [1]
* From topic [^1](Relationship Title)
```

--------------------------------

### Browser API: parseXMindMarkToXMindFile

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Parses XMindMark text content into an XMind binary file within the browser.

```APIDOC
## xmindmark.parseXMindMarkToXMindFile

### Description
Asynchronously converts a string of XMindMark content into an ArrayBuffer representing an XMind file.

### Method
JavaScript Function

### Parameters
- **content** (string) - Required - The XMindMark formatted text.

### Response
- **ArrayBuffer** - The binary data of the generated .xmind file.
```

--------------------------------

### Define Central and Sub-topics

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Use indentation and prefixes to define the hierarchical structure of a mind map.

```xmindmark
Project Planning
- Phase 1
    * Research
    * Requirements
- Phase 2
    * Development
        - Frontend
        - Backend
    * Testing
- Phase 3
    * Deployment
    * Maintenance
```

--------------------------------

### CLI: Convert XMindMark to SVG

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Generates SVG images from XMindMark files.

```APIDOC
## Convert XMindMark to SVG

### Description
Generates SVG visual representations from XMindMark files.

### Method
CLI Command

### Endpoint
xmindmark -f svg [file]

### Parameters
#### Query Parameters
- **-f, --format** (string) - Required - Set to 'svg'.
- **-o, --outputDir** (string) - Optional - Specify the output directory for generated files.
```

--------------------------------

### Generate XMind File from XMindMark Content

Source: https://github.com/xmindltd/xmindmark/blob/main/samples/use-with-vanilla-js/index.html

Use this snippet to convert XMindMark formatted content into an XMind file. The result is an ArrayBuffer that can be saved or uploaded.

```javascript
const content = `Central Topic\n- Main Topic 1\n- Main Topic 2\n`
xmindmark.parseXMindMarkToXMindFile(content)
  .then(arrayBuffer => {
    // Data of generated .xmind file
    // Save as local file or upload to somewhere.
  })
```

--------------------------------

### Add Summary Topics

Source: https://github.com/xmindltd/xmindmark/blob/main/docs/specification.md

Use `[S<number?>]` after topics to associate them with a summary. If no title is provided after the marker, a default summary topic title will be generated. Similar to boundaries, topics with the same summary marker at the same level share a single summary.

```xmindmark
* topic 1 [S]
* topic 2 [S]
[S]: Summary Topic
```

```xmindmark
* topic 1 [S1]
* topic 2 [S1]
[S1]: Summary Topic
```

--------------------------------

### createMapByXMindMark

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Low-level parser that creates a SheetModel object from XMindMark content.

```APIDOC
## createMapByXMindMark

### Description
Parses XMindMark content into a structured SheetModel object for custom processing or inspection.

### Parameters
- **content** (string) - Required - The XMindMark text content.

### Response
- **SheetModel** - An object representing the mind map structure, including rootTopic, children, and relationships.
```

--------------------------------

### parseXMindMarkToXMindFile

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Converts XMindMark text content into an XMind file format.

```APIDOC
## parseXMindMarkToXMindFile

### Description
Converts XMindMark text content to an XMind file format. Returns an ArrayBuffer containing a compressed .xmind file.

### Parameters
- **xmindMarkContent** (string) - Required - The plain text content formatted in XMindMark syntax.

### Response
- **ArrayBuffer** - The binary data representing the .xmind file.
```

--------------------------------

### Define Central Topic

Source: https://github.com/xmindltd/xmindmark/blob/main/docs/specification.md

The first line of an XMindMark file is treated as the central topic. Any preceding empty lines are ignored.

```xmindmark
Central Topic
```

--------------------------------

### Define Topic Relationships

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Connect topics using numeric markers to indicate source and target relationships.

```xmindmark
Software Development
- Requirements [1]
- Design
    * Architecture [^1](informs)
    * UI Design
- Implementation [2]
- Testing [^2](validates)
```

--------------------------------

### Combine Boundaries and Relationships

Source: https://github.com/xmindltd/xmindmark/blob/main/docs/specification.md

Boundaries can participate in relationships. Treat the boundary title like a normal topic by appending relationship markers `[<number>]` or `[^<number>]`.

```xmindmark
- main topic
    * topic 1 [B]
    * topic 2 [B]
    [B]: Boundary Title [1]
- main topic [^1]
```

--------------------------------

### Define Boundaries

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Group related topics using boundary markers.

```xmindmark
Seasons
- Spring [B1]
- Summer [B1]
[B1]: Warm Seasons
- Autumn [B2]
- Winter [B2]
[B2]: Cold Seasons
```

--------------------------------

### Convert XMind to XMindMark

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Use parseXMindToXMindMarkFile to extract text content from an existing .xmind file.

```typescript
import { parseXMindToXMindMarkFile } from 'xmindmark/dist/src/lib/xmind-to-xmindmark'
import { readFileSync } from 'fs'

// Read XMind file as ArrayBuffer
const xmindFile = readFileSync('existing-mindmap.xmind')
const arrayBuffer = xmindFile.buffer.slice(
  xmindFile.byteOffset,
  xmindFile.byteOffset + xmindFile.byteLength
)

// Convert to XMindMark (first sheet by default)
const xmindMarkContent = await parseXMindToXMindMarkFile(arrayBuffer)
console.log(xmindMarkContent)
// Output:
// Central Topic
// - Main Topic 1
// - Main Topic 2

// Convert specific sheet (second sheet)
const secondSheet = await parseXMindToXMindMarkFile(arrayBuffer, 1)
```

--------------------------------

### Parse XMindMark to SheetModel

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Use createMapByXMindMark to generate a structured object for programmatic inspection.

```typescript
import { createMapByXMindMark } from 'xmindmark/dist/src/parser/mindmark'

const content = `
Team Structure
- Engineering [B]
    * Frontend
    * Backend
    * DevOps
[B]: Tech Team
- Product [1]
- Design [^1](collaborates with)
`

const sheetModel = createMapByXMindMark(content)

// Access the root topic
console.log(sheetModel.rootTopic.title) // "Team Structure"

// Access children
const mainTopics = sheetModel.rootTopic.children?.attached || []
mainTopics.forEach(topic => {
  console.log(`- ${topic.title}`)
  topic.children?.attached?.forEach(sub => {
    console.log(`  * ${sub.title}`)
  })
})

// Access relationships
sheetModel.relationships?.forEach(rel => {
  console.log(`Relationship: ${rel.end1Id} -> ${rel.end2Id}`)
})
```

--------------------------------

### Convert XMindMark to XMind File (Javascript)

Source: https://github.com/xmindltd/xmindmark/blob/main/README.md

Use the parseXMindMarkToXMindFile function from the xmindmark library to convert XMindMark content string to an ArrayBuffer of an .xmind file.

```typescript
import { parseXMindMarkToXMindFile } from 'xmindmark'

const xmindMarkFileContent = `
Central Topic
- Main Topic 1
- Main Topic 2
`

const xmindArrayBuffer = await parseXMindMarkToXMindFile(xmindMarkFileContent)
```

--------------------------------

### Define XMindMark Data Models

Source: https://context7.com/xmindltd/xmindmark/llms.txt

TypeScript type definitions for the mind map structure, including sheets, topics, boundaries, summaries, and relationships.

```typescript
type SheetModel = {
  id: string
  class: string           // "sheet"
  title: string           // Sheet/central topic title
  rootTopic: TopicModel   // The central topic
  topicPositioning: string
  relationships?: RelationshipModel[]
}

type TopicModel = {
  id: string
  title: string
  class?: string
  structureClass?: string
  titleUnedited?: boolean
  boundaries?: BoundaryModel[]
  summaries?: SummaryModel[]
  labels?: string[]
  children?: {
    attached?: TopicModel[]   // Regular sub-topics
    detached?: TopicModel[]   // Floating topics
    summary?: TopicModel[]    // Summary topics
  }
}

type BoundaryModel = {
  id: string
  title: string
  range: `(${number},${number})`  // Topic index range
  titleUnedited: boolean
}

type SummaryModel = {
  id: string
  range: `(${number},${number})`
  topicId: string  // ID of the summary topic
}

type RelationshipModel = {
  id: string
  end1Id: string   // Source topic ID
  end2Id: string   // Target topic ID
  title: string
}
```

--------------------------------

### parseXMindToXMindMarkFile

Source: https://context7.com/xmindltd/xmindmark/llms.txt

Converts an XMind file (ArrayBuffer) back to XMindMark text format.

```APIDOC
## parseXMindToXMindMarkFile

### Description
Converts an XMind file (ArrayBuffer) back to XMindMark text format. Optionally specify which sheet to convert.

### Parameters
- **arrayBuffer** (ArrayBuffer) - Required - The binary data of the .xmind file.
- **sheetIndex** (number) - Optional - The 0-indexed sheet to convert. Defaults to 0.

### Response
- **string** - The converted XMindMark text content.
```
Tokens:
Raw