XMind SDK for JavaScript 使用教程

1. 项目的目录结构及介绍

XMind SDK for JavaScript 的目录结构如下：

xmind-sdk-js/
├── examples/
│   ├── basic-usage.js
│   └── ...
├── lib/
│   ├── core.js
│   ├── parser.js
│   └── ...
├── test/
│   ├── core.test.js
│   └── ...
├── .gitignore
├── .npmignore
├── LICENSE
├── package.json
├── README.md
└── ...

目录结构介绍

• examples/: 包含一些示例代码，展示如何使用 SDK。
• lib/: 核心库文件，包含 SDK 的主要功能实现。
• test/: 测试文件，用于测试 SDK 的功能。
• .gitignore: Git 忽略文件列表。
• .npmignore: npm 忽略文件列表。
• LICENSE: 项目许可证。
• package.json: 项目的 npm 配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件通常是 examples/basic-usage.js，这是一个简单的示例，展示了如何使用 XMind SDK for JavaScript 创建和操作思维导图。

示例代码

const { XMind } = require('xmind');

async function main() {
    const workbook = new XMind.Workbook();
    const sheet = workbook.createSheet('sheet1', 'Central Topic');
    sheet.addTopic(sheet.getRootTopic(), 'Main Topic 1');
    await workbook.save('example.xmind');
}

main();

代码解释

• const { XMind } = require('xmind');: 引入 XMind SDK。
• const workbook = new XMind.Workbook();: 创建一个新的工作簿。
• const sheet = workbook.createSheet('sheet1', 'Central Topic');: 在工作簿中创建一个新的思维导图。
• sheet.addTopic(sheet.getRootTopic(), 'Main Topic 1');: 在思维导图中添加一个主主题。
• await workbook.save('example.xmind');: 保存工作簿到文件。

3. 项目的配置文件介绍

项目的配置文件主要是 package.json，它包含了项目的元数据和依赖信息。

package.json 示例

{
  "name": "xmind-sdk-js",
  "version": "1.0.0",
  "description": "XMind SDK for JavaScript",
  "main": "lib/core.js",
  "scripts": {
    "test": "jest"
  },
  "dependencies": {
    "fs-extra": "^9.0.1"
  },
  "devDependencies": {
    "jest": "^26.6.3"
  },
  "author": "XMind Ltd.",
  "license": "MIT"
}

配置文件解释

• "name": 项目名称。
• "version": 项目版本。
• "description": 项目描述。
• "main": 项目的主入口文件。
• "scripts": 脚本命令，例如运行测试的 npm test。
• "dependencies": 项目运行时的依赖。
• "devDependencies": 开发时的依赖。
• "author": 项目作者。
• "license": 项目许可证。