自定义锚点使用说明
本文档说明如何使用自定义锚点功能,实现跨文档的精确引用。
语法说明
1. 定义锚点
在文档中插入一个不可见的锚点:
[anchor:my-anchor-id]
规则:
- 锚点 id 只能包含字母、数字、连字符和下划线
- 锚点不占用视觉空间,不会影响文档排版
- 建议使用有意义的命名,例如
node-operations、character-attributes等
2. 引用锚点
同文档内引用:
[跳转到节点操作](#node-operations)
跨文档引用:
[详细操作说明](/help/03-editor/05-plot-canvas#node-operations)
使用场景
场景1:避免重复内容
当多篇文档需要讲解相同的功能时,可以在一篇文档中详细讲解,其他文档简短说明并链接过去。
示例:
在 05-plot-canvas.md 中定义锚点:
**针对节点的操作** [anchor:node-operations] **节点头部的快捷按钮** 当你把鼠标移到节点的标题栏时,右上角会出现三个小按钮: (详细内容...)
在 06-character-canvas.md 中引用:
**针对节点的操作** 角色节点的操作方式和情节画布中的节点操作基本一致。 详细的操作说明请参考:[情节画布 - 节点操作](/help/03-editor/05-plot-canvas#node-operations)
场景2:引用非标题位置
当你需要引用文档中的某个特定段落(不是标题)时:
这是一段重要的说明文字。[anchor:important-note] (其他内容...) 然后在别处引用:[查看重要说明](#important-note)
与标题锚点的区别
标题锚点(自动生成):
## 节点与通用操作 引用方式:[跳转](#节点与通用操作)
自定义锚点(手动定义):
[anchor:node-operations] **节点头部的快捷按钮** 引用方式:[跳转](#node-operations)
区别:
- 标题锚点:自动生成,id 是标题文本(中文),可能较长
- 自定义锚点:手动定义,id 可以自定义(英文),更简洁,不依赖标题文本
建议:
- 优先使用标题锚点(简单、自动)
- 需要引用非标题位置时,使用自定义锚点
- 需要更简洁的 id 时,使用自定义锚点
注意事项
- 锚点 id 唯一性:同一文档内不要定义重复的锚点 id
- 命名规范:使用小写字母、连字符分隔,例如
node-operations、character-attributes - 位置选择:锚点通常放在要引用的内容之前(例如段落开头、小标题前)
- 滚动偏移:点击锚点链接后,页面会自动滚动到锚点位置,并留出顶部导航栏的空间(6rem)
实际案例
查看以下文档中的实际使用: