You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: enhance XMindMark syntax with examples for hyperlinks, notes, and folded topics
- Added examples and usage details for new features in the XMindMark syntax documentation.
- Updated HTML to include a link to the npm package and improved the instruction layout in the editor.
- Implemented local storage functionality to save and load editor content.
Copy file name to clipboardExpand all lines: README.md
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,7 +72,7 @@ npm run build
72
72
73
73
XMindMark syntax is similar to Markdown, using indentation and special symbols to represent the hierarchical structure and relationships of elements in the mind map.
74
74
75
-
#### Basic Syntax Example:
75
+
#### Basic Syntax Example
76
76
77
77
```
78
78
Central Topic
@@ -85,11 +85,14 @@ Central Topic
85
85
- Subsubtopic 2.1.1
86
86
```
87
87
88
-
#### Special Features:
88
+
#### Advanced Syntax
89
89
90
90
-**Relationships**: Use `[number]` and `[^number]` to create connections between topics
91
91
-**Boundaries**: Use `[B]` or `[Bnumber]` to create boundaries
92
92
-**Summaries**: Use `[S]` or `[Snumber]` to create summaries
93
+
-**Hyperlinks**: Use `[L:url]` to add hyperlinks to topics
94
+
-**Notes**: Use `[N:content]` to add text notes to topics
95
+
-**Folding**: Use `[F]` to make topics appear folded
Copy file name to clipboardExpand all lines: docs/specification.md
+63-9Lines changed: 63 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -222,20 +222,74 @@ Central Topic
222
222
- subtopic 2 [B]
223
223
```
224
224
225
-
#Advanced usage
225
+
## Hyperlinks
226
226
227
-
### Perform multiple marker symbol at one topic
227
+
**_Syntax: `[L:url]` - This marker symbol adds a hyperlink to a topic._**
228
228
229
-
Every marker symbol of topic must be placed after topic contentwithout any spaces. Like:
229
+
Add a hyperlink to a topic by appending `[L:url]` after the topic content. The URL should be placed inside the brackets without any spaces between `L:` and the URL.
230
230
231
+
```
232
+
Central Topic
233
+
234
+
- Topic with hyperlink [L:https://example.com]
235
+
- Another topic
231
236
```
232
237
233
-
Seasons of 2021
238
+
Hyperlinks can be combined with other markers:
239
+
240
+
```
241
+
Central Topic
234
242
235
-
- Spring [1]
236
-
- Summer [B1]
237
-
- Autumn [B1][^1](Cool)[S1]
238
-
- Winter [S1]
243
+
- Topic with hyperlink and boundary [L:https://example.com][B]
239
244
```
240
245
241
-
In the example above, "Summer" and "Autumn" will be wrapped by a boundary, "Autumn" and "Winter" will be wrapped by a summary topic, a relationship will connected "Spring" and "Autumn" with title: "Cool".
246
+
## Notes
247
+
248
+
**_Syntax: `[N:content]` - This marker symbol adds text notes to a topic._**
249
+
250
+
Add text notes to a topic by appending `[N:content]` after the topic content. The note content should be placed inside the brackets without any spaces between `N:` and the content.
251
+
252
+
```
253
+
Central Topic
254
+
255
+
- Topic with a note [N:This is an important note]
256
+
- Another topic
257
+
```
258
+
259
+
Notes currently only support plain text content. Complex formatted content or HTML is not supported in the note content.
260
+
261
+
Notes can be combined with other markers:
262
+
263
+
```
264
+
Central Topic
265
+
266
+
- Topic with note and summary [N:Remember this detail][S]
267
+
```
268
+
269
+
## Folded Topics
270
+
271
+
**_Syntax: `[F]` - This marker symbol makes a topic appear folded._**
272
+
273
+
Make a topic appear folded (collapsed) by appending `[F]` after the topic content.
274
+
275
+
```
276
+
Central Topic
277
+
278
+
- Folded topic with subtopics [F]
279
+
* Subtopic 1
280
+
* Subtopic 2
281
+
```
282
+
283
+
This is particularly useful for complex mind maps where you want certain branches to be initially collapsed for better readability.
0 commit comments