MineGraph Docs Help

Writerside 快速上手

开始创作

  1. 在 Writerside 侧栏的正确目录下创建 Topic

    create_topic_on_correct_directory

  2. 在 项目 侧栏将你的文档文件移入对应的文件夹

    move_file_to_correct_folder

IDE 快捷键

文件内定位章节 CtrlF12
重命名文件 ShiftF6
文件内搜索 CtrlF
全局搜索 Shift, Shift

常用格式

标题

# 文档标题 ## 二级标题 ... ##### 五级标题

XML / HTML 代码

环绕插入行内代码 框选内容, CtrlAltT, T

<代码>内容</代码>

环绕插入代码块 框选内容, CtrlAltT, B

<代码> 内容块 </代码>

字形

斜体 CtrlI

*文字*

或

_文字_

或

<i>文字</i>

    粗体 CtrlB

    **文字**

    或

    __文字__

    或

    <b>文字</b>

      粗斜体 CtrlI, CtrlB

      **_文字_**

      或

      ***文字***

      或

      __*文字*__

      或

      <b><i>文字</i></b>

      或

      <i><b>文字</b></i>

      ...等

        删除线 CtrlShiftS

        ~~文字~~

        或

        <s>文字</s>

          行内代码块 CtrlShiftC

          `文字`

          或

          <code>文字</code>

            链接 CtrlShiftU

            [文字](<站内文档文件名#章节 | 外部链接>)

            或

            <外部链接> <- 使用尖括号括起来即可

            或

            <a href="<站内文档文件名#章节 | 外部链接>">文字</a>

            鼠标悬停在站内文档链接上时默认弹出跳转处的标题栏下第一段文字作为概述，如果想自定义内容，可以使用

            [文字](<站内文档文件名#章节 | 外部链接> "描述")

            或

            [文字](<站内文档文件名#章节 | 外部链接>){summary="描述"}

            或

            <a href="<站内文档文件名#章节 | 外部链接>" summary="描述">文字</a>

            要禁用自动描述，请直接在 []() 后加 {summary=""}

            [文字](<站内文档文件名#章节>){summary=""}

            或

            <a href="<站内文档文件名#章节>" summary="">文字</a>

            当 [] 内没有内容时，默认使用章节标题（站内）或完整链接（站外）作为文本。 例： 知识库， https://b23.tv/BV1GJ411x7h7

              角标

              ^上角标^ ~下角标~

              或

              <sup>上角标</sup> <sub>下角标</sub>

                按键

                <shortcut>文字</shortcut>

                编写规范：
                同时按下的按键 按键A按键B按键C
                分步骤按下的按键 按键A, 按键B, 按键C
                按住的按键 ^按键
                例： CtrlShiftEsc, ^↓, AltE

                  高级文本块

                  这些文本块请结合源文件和预览页面进行阅读

                  这些块大多数可以嵌套或通过 Tab 缩进进行悬挂，如果遇到问题请使用 XML 语法。

                  省流块

                  术语块

                  标题 1

                  内容 1

                  标题 2

                  内容 2

                  或

                  标题 1

                  内容 1

                  标题 2

                  内容 2

                  代码块

                  内容
                  <code-block> 块
                  内容

                  注释／提示／警告

                  缩写

                  文本

                  步骤

                  无序步骤

                  • 步骤 1

                  • 步骤 2

                    • 子步骤 1

                  • 步骤 3

                  有序步骤

                  1. 步骤 1

                  2. 步骤 2

                    1. 子步骤 1

                  3. 步骤 3

                  <list> 块

                  1. 步骤 1

                  2. 步骤 2

                  3. 步骤 3

                  4. 步骤 4

                  步骤块

                  有序步骤

                  1. 步骤1

                  2. 步骤2

                  无序步骤

                  • 步骤1

                  • 步骤2

                  新起段落

                  段落 1

                  段落 2

                  <p> 块

                  段落 1

                  段落 2

                  仅换行

                  行 1
                  行 2

                  <br/> 符

                  行 1
                  行 2

                  表格

                  表头1

                  表头2

                  ...

                  内容1

                  内容2

                  ...

                  内容3

                  内容4

                  ...

                  <table> 块

                  双表头

                  列表头1

                  列表头2

                  列表头3

                  行表头1

                  内容1

                  内容3

                  行表头2

                  内容2

                  行表头3

                  内容4

                  行表头4

                  选项卡

                  内容A

                  内容B

                  使用 group 和 group-key 同步切换标签页，当 group 和 group-key 值相同时，选项卡将会同步切换：

                  内容A

                  内容B

                  内容C

                  内容D

                  复用块

                  插入复用块

                  <include from="源文件" element-id="复用块ID"/>

                  添加新的复用块

                  <snippet id="复用块ID"> 复用块内容 </snippet>

                  变量

                  变量主要用于使用复用块时更改块内的内容。

                  1. 在调用变量名之前使用

                    <var name="变量名" value="不包含任何xml/md格式的文本"/>

                    ，或将全局变量保存至 v.list

                  2. 在任意位置使用 %变量名%

                  变量值中不可包含任何 markdown 语法或 XML 语法。

                  试图在%fVar%使用%lang%语法。

                  试图在<b>这里</b>使用xml语法。

                  试图在**这里**使用md语法。

                    变量名可以和复用块一起使用，使用方法同上例。

                    可折叠块

                    章节

                    内容

                    代码块 内容

                    步骤块

                    内容

                      术语块

                      内容

                      数学公式

                      行内公式

                      文本， ，另外一些文本

                      或使用 <math> 标签环绕。

                      公式块

                      文本，

                      另一些文本
                      再来一些文本，

                      更多的文本

                      或使用代码块环绕，并将语言设置为 tex。

                      索引深度

                      <show-structure depth="<int>"/>

                      标签

                      对应颜色示例见上方，标签存储于 Writerside/labels.list。

                      注释和待办事项（TODO）

                      新起一行并使用

                      [//]: # (注释内容)

                      进行注释，或直接按下 Ctrl/ 注释当前行

                      一个板块应当在完成之后再取消注释

                      在注释内容中写入 TODO 字段自动标记为待办事项，没有大小写限制， TODO 后需要接空格或者符号才能继续写注释
                      例：

                      [//]: # (TODO) [//]: # (toDO: 描述) [//]: # (TOdO-描述)

                      你可以在 IDE 的左侧栏下方第二个按钮查看整个文档中的待办事项。

                      编写时的注意事项

                      格式

                      • 如果使用了 XML 代码，你需要空一行才能继续 markdown 格式；

                        这段话**不能**正常使用 `markdown 格式` 。

                          这段话可以正常使用 markdown 格式。

                            • 字形类 XML 代码可以在行首使用；

                          1. 在西文和中文之间应添加空格；

                          2. 不要滥用特殊字形；

                            • 有时候斜体可能会显得过于紧凑，可以在 斜体 前后加空格来避免；

                          3. 涉及文件路径的格式应当统一（至少在单个文档内统一），例如 F:/Codes/hw.cpp C:\Windows\；

                          4. 涉及点击次序（多级菜单）的，顺序中间使用 > 或 →， 不要使用 -> ，这会在渲染后的文档中产生断层！ 同时也应当注意同文档内统一；

                          5. 未经允许不得擅自修改他人文档，我们在合并 Pull Request 时会进行审查；

                          6. 我们会对所有文档进行重格式化和订正，因此可能会略微调整你所写的内容。

                          7. 使用连续的三根横线 --- 可以隔断 markdown 块。

                          8. 在任意 markdown 块下空一行（如果对应块下会强制换行则不需要再空一行，比如表格）再使用 {} 可以定义对应 xml 块的属性。例：

                            表头1

                            表头2

                            内容

                            内容

                            表头1

                            表头2

                            内容

                            内容

                            • 列表结束后不会强制换行，所以要空一行，

                            • 不然无法应用格式。

                            • 列表结束后不会强制换行，所以要空一行，

                            • 不然无法应用格式。

                            你应该（Should do）

                            • 给自己的文档起一个恰当的名字；

                            • 语言简洁明了，尽量让文字能直接表述你的观点；

                            • 引用参考资料时在文尾附上明确的来源。

                            你不应该（Should NOT do）

                            • 将文档上传至错误的分区；

                            • 不按照正确格式编写或使用不准确的文本；

                            • 对于没有确定的结论，不加以说明就编写进入文档；

                            • 未经管理组和其他执笔者同意，擅自变更由其他执笔者编写的文档内容。

                            你不能（MUST NOT do）

                            • 编写无关内容和违反社区相关规定的内容；

                            • 在文档内插入无关内容和违反社区相关规定的内容；

                            • 未经授权搬运、冒名使用他人研究成果；

                            • 在没有事实考究的情况下，轻易编写文档；

                            • 随意、轻易更改客观事实内容和已经定型的内容。

                            09 四月 2025
                            关于