Skip to content

Commit 3151e84

Browse files
CoderJackZhuclaude
andcommitted
refactor: rename project from MindDoc to MindCtx
- 包名: @minddoc/* → @mindctx/*, vscode-minddoc → vscode-mindctx - 类名/类型: MindDoc* → MindCtx* - 视图类型: minddoc-view → mindctx-view - 命令前缀: minddoc.* → mindctx.* - CSS 类名: minddoc-* → mindctx-* - 文件后缀 .mind.md 保持不变 Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 1505745 commit 3151e84

99 files changed

Lines changed: 1483 additions & 1483 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/ci.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ jobs:
2323

2424
- run: pnpm install --frozen-lockfile
2525

26-
- run: pnpm --filter @minddoc/core typecheck
27-
- run: pnpm --filter @minddoc/core build
26+
- run: pnpm --filter @mindctx/core typecheck
27+
- run: pnpm --filter @mindctx/core build
2828

29-
- run: pnpm --filter @minddoc/obsidian typecheck
30-
- run: pnpm --filter vscode-minddoc typecheck
29+
- run: pnpm --filter @mindctx/obsidian typecheck
30+
- run: pnpm --filter vscode-mindctx typecheck
3131

32-
- run: pnpm --filter @minddoc/core test
32+
- run: pnpm --filter @mindctx/core test
3333

3434
- run: pnpm build

.github/workflows/release-obsidian.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222

2323
- run: pnpm install --frozen-lockfile
2424

25-
- run: pnpm --filter @minddoc/obsidian build
25+
- run: pnpm --filter @mindctx/obsidian build
2626

2727
- name: Get version from tag
2828
id: tag

.github/workflows/release-vscode.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222

2323
- run: pnpm install --frozen-lockfile
2424

25-
- run: pnpm --filter vscode-minddoc build
25+
- run: pnpm --filter vscode-mindctx build
2626

2727
- name: Get version from tag
2828
id: tag

.github/workflows/release.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ jobs:
2121
- uses: softprops/action-gh-release@v2
2222
with:
2323
body: |
24-
# MindDoc v0.0.1 — 首个社区预览版
24+
# MindCtx v0.0.1 — 首个社区预览版
2525
26-
MindDoc 是一个 Obsidian 插件,将 Markdown 文件转化为交互式大纲与思维导图,数据始终以 `.mind.md` 文件存储,完全兼容 Obsidian 生态。
26+
MindCtx 是一个 Obsidian 插件,将 Markdown 文件转化为交互式大纲与思维导图,数据始终以 `.mind.md` 文件存储,完全兼容 Obsidian 生态。
2727
2828
## 双视图编辑
2929
- **大纲视图**:拖拽排序、键盘快捷键、行内编辑
@@ -47,7 +47,7 @@ jobs:
4747
- 祖先节点保持可见,不丢失上下文
4848
4949
## 嵌入块
50-
- Markdown 中通过 ````minddoc` 代码块嵌入只读视图
50+
- Markdown 中通过 ````mindctx` 代码块嵌入只读视图
5151
- 可配置视图模式、高度、最大深度、初始折叠状态
5252
5353
## 导入导出

README-en.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# MindDoc
1+
# MindCtx
22

33
Markdown-first structured outline editor with mind map view — for Obsidian and VS Code.
44

@@ -32,18 +32,18 @@ Write standard Markdown, see interactive outlines, switch to mind maps — all b
3232

3333
| Platform | Package | Notes |
3434
|----------|---------|-------|
35-
| [Obsidian](packages/obsidian/) | `@minddoc/obsidian` | Community plugin, embed blocks, mobile support |
36-
| [VS Code](packages/vscode/) | `vscode-minddoc` | Custom Editor extension, native undo/redo integration |
35+
| [Obsidian](packages/obsidian/) | `@mindctx/obsidian` | Community plugin, embed blocks, mobile support |
36+
| [VS Code](packages/vscode/) | `vscode-mindctx` | Custom Editor extension, native undo/redo integration |
3737

38-
Both platforms share the same core engine: [`@minddoc/core`](packages/core/).
38+
Both platforms share the same core engine: [`@mindctx/core`](packages/core/).
3939

4040
## File Format
4141

42-
MindDoc works with standard Markdown. Headings become tree branches, lists become leaf nodes:
42+
MindCtx works with standard Markdown. Headings become tree branches, lists become leaf nodes:
4343

4444
```markdown
4545
---
46-
minddoc: true
46+
mindctx: true
4747
heading-depth: 3
4848
---
4949

@@ -111,16 +111,16 @@ examples/ # Sample .mind.md files
111111

112112
```bash
113113
# Develop Obsidian plugin (watch mode)
114-
pnpm --filter @minddoc/obsidian dev
114+
pnpm --filter @mindctx/obsidian dev
115115

116116
# Develop VS Code extension (watch mode)
117-
pnpm --filter vscode-minddoc dev
117+
pnpm --filter vscode-mindctx dev
118118

119119
# Build core only
120-
pnpm --filter @minddoc/core build
120+
pnpm --filter @mindctx/core build
121121

122122
# Run tests
123-
pnpm --filter @minddoc/core test
123+
pnpm --filter @mindctx/core test
124124
```
125125

126126
## Documentation

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# MindDoc
1+
# MindCtx
22

33
Markdown 优先的结构化大纲编辑器,支持思维导图视图 —— 同时适配 Obsidian 和 VS Code。
44

55
写标准 Markdown,看交互式大纲,切换思维导图——所有数据始终存储在同一个 `.md` 文件中。原生 LLM 协作:一键将脑图转为结构化提示词,AI 输出回写即节点。
66

7-
## 为什么选择 MindDoc
7+
## 为什么选择 MindCtx
88

9-
市面上不乏大纲工具和思维导图软件,但 MindDoc 的设计出发点是解决几个被忽略的痛点:
9+
市面上不乏大纲工具和思维导图软件,但 MindCtx 的设计出发点是解决几个被忽略的痛点:
1010

11-
**Markdown 即数据源,而非导出格式。** 大多数思维导图工具把 Markdown 当作导入/导出的二等公民——导出的 md 丢失结构、导入后无法双向同步。MindDoc`.md` 文件成为唯一的真实数据源,编辑结果直接写回原文件,Git 可追踪、任意编辑器可打开。
11+
**Markdown 即数据源,而非导出格式。** 大多数思维导图工具把 Markdown 当作导入/导出的二等公民——导出的 md 丢失结构、导入后无法双向同步。MindCtx`.md` 文件成为唯一的真实数据源,编辑结果直接写回原文件,Git 可追踪、任意编辑器可打开。
1212

1313
**为 LLM 协作而生。** `.mind.md` 是标准 Markdown,大模型天然就能读懂和生成。通过"复制为 AI 上下文"功能,一键将当前脑图结构转化为结构化提示词,粘贴给 ChatGPT/Claude 即可获得精准的文档整理、思路扩展或内容润色——AI 的输出拖回来直接就是可编辑的节点。
1414

@@ -44,18 +44,18 @@ Markdown 优先的结构化大纲编辑器,支持思维导图视图 —— 同
4444

4545
| 平台 | 包名 | 说明 |
4646
|------|------|------|
47-
| [Obsidian](packages/obsidian/) | `@minddoc/obsidian` | 社区插件,支持嵌入块、移动端 |
48-
| [VS Code](packages/vscode/) | `vscode-minddoc` | Custom Editor 扩展,原生撤销/重做集成 |
47+
| [Obsidian](packages/obsidian/) | `@mindctx/obsidian` | 社区插件,支持嵌入块、移动端 |
48+
| [VS Code](packages/vscode/) | `vscode-mindctx` | Custom Editor 扩展,原生撤销/重做集成 |
4949

50-
两个平台共享同一个核心引擎 [`@minddoc/core`](packages/core/)
50+
两个平台共享同一个核心引擎 [`@mindctx/core`](packages/core/)
5151

5252
## 文件格式
5353

54-
MindDoc 使用标准 Markdown。标题成为树的分支,列表成为叶节点:
54+
MindCtx 使用标准 Markdown。标题成为树的分支,列表成为叶节点:
5555

5656
```markdown
5757
---
58-
minddoc: true
58+
mindctx: true
5959
heading-depth: 3
6060
---
6161

@@ -126,16 +126,16 @@ examples/ # 示例 .mind.md 文件
126126

127127
```bash
128128
# 开发 Obsidian 插件(监听模式)
129-
pnpm --filter @minddoc/obsidian dev
129+
pnpm --filter @mindctx/obsidian dev
130130

131131
# 开发 VS Code 扩展(监听模式)
132-
pnpm --filter vscode-minddoc dev
132+
pnpm --filter vscode-mindctx dev
133133

134134
# 只构建核心包
135-
pnpm --filter @minddoc/core build
135+
pnpm --filter @mindctx/core build
136136

137137
# 运行测试
138-
pnpm --filter @minddoc/core test
138+
pnpm --filter @mindctx/core test
139139
```
140140

141141
## 文档

assets/vscode show.png

208 KB
Loading

docs/format-spec.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
# mind.md 格式规范
22

3-
MindDoc 使用标准 Markdown 作为数据格式。本文档定义 `.mind.md` 文件的完整规范。
3+
MindCtx 使用标准 Markdown 作为数据格式。本文档定义 `.mind.md` 文件的完整规范。
44

55
## 文件识别
66

7-
一个 Markdown 文件通过以下两种方式被识别为 MindDoc 文档:
7+
一个 Markdown 文件通过以下两种方式被识别为 MindCtx 文档:
88

99
1. 文件扩展名为 `.mind.md`
10-
2. 任意 `.md` 文件的 YAML frontmatter 中包含 `minddoc: true`
10+
2. 任意 `.md` 文件的 YAML frontmatter 中包含 `mindctx: true`
1111

1212
## Frontmatter
1313

1414
```yaml
1515
---
16-
minddoc: true
16+
mindctx: true
1717
default-view: outline
1818
heading-depth: 3
1919
---
2020
```
2121

2222
| 字段 | 类型 | 默认值 | 说明 |
2323
|------|------|--------|------|
24-
| `minddoc` | boolean || 标记文件为 MindDoc 文档(非 `.mind.md` 文件必填) |
24+
| `mindctx` | boolean || 标记文件为 MindCtx 文档(非 `.mind.md` 文件必填) |
2525
| `default-view` | string | `"outline"` | 默认打开的视图,可选 `"outline"``"mindmap"` |
2626
| `heading-depth` | integer | `3` | 标题最大深度(1–6),超过此深度的节点序列化为列表项 |
2727

2828
## 树结构映射
2929

30-
MindDoc 将 Markdown 解析为树形结构。映射规则如下:
30+
MindCtx 将 Markdown 解析为树形结构。映射规则如下:
3131

3232
### 标题 → 分支节点
3333

@@ -161,7 +161,7 @@ MindDoc 将 Markdown 解析为树形结构。映射规则如下:
161161

162162
## 序列化规则
163163

164-
MindDoc 的序列化器遵循「最小变更」原则:
164+
MindCtx 的序列化器遵循「最小变更」原则:
165165

166166
1. **未修改节点**:输出原始文本(`rawText`),保持用户的原始格式
167167
2. **已修改节点**`dirty: true`):从结构化数据重新生成
@@ -205,7 +205,7 @@ ID = fnv1a64("祖先标题1/祖先标题2/当前标题:兄弟索引")
205205

206206
```markdown
207207
---
208-
minddoc: true
208+
mindctx: true
209209
default-view: outline
210210
heading-depth: 3
211211
---
@@ -281,4 +281,4 @@ heading-depth: 3
281281

282282
## 与标准 Markdown 的兼容性
283283

284-
`.mind.md` 文件是合法的 Markdown,可以在任何 Markdown 编辑器中直接阅读和编辑。MindDoc 不引入任何私有语法,仅通过 frontmatter 中的 `minddoc: true` 和文件扩展名来标识。
284+
`.mind.md` 文件是合法的 Markdown,可以在任何 Markdown 编辑器中直接阅读和编辑。MindCtx 不引入任何私有语法,仅通过 frontmatter 中的 `mindctx: true` 和文件扩展名来标识。

0 commit comments

Comments
 (0)