参与贡献#

Markdown 语法#

本文档采用myst-parser渲染，语法规范及其额外的可用指令见：https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html。

备注

如果你以前使用过 Markdown ，你可能需要注意以下几个特殊的渲染指令和链接方法。（意即，非标准语法）

  1. Directives

    :::{warning} 除了`admonition`以外，此处文本均显示的是内容。
:::

    将显示为

    警告

    除了admonition以外，此处文本均显示的是内容。

    :::{tip} <!--第一行提示文本，当然我这里也可以不写啦！-->

如果有多行，记得要多空一行哦。

这里是我要写的内容哦～
:::

    将显示为

    小技巧

    如果有多行，记得要多空一行哦。

    这里是我要写的内容哦～

  2. 链接到另一个文件

    [那啥，提问的智慧啊！](/名词解释/提问的智慧.md)[而且还是提问的智慧啊！](../%E5%90%8D%E8%AF%8D%E8%A7%A3%E9%87%8A/%E6%8F%90%E9%97%AE%E7%9A%84%E6%99%BA%E6%85%A7.md)

    将显示为

    那啥，提问的智慧啊！而且还是提问的智慧啊！

  3. Dropdown (powered by sphinx_design)

     :::{Dropdown} 如果你有一堆话想说
 不如放到里面来说
 :::

    将显示为

    如果你有一堆话想说

    还真是，我还真有一堆话想说。

    可以检查下你写的文件里有没有以下错误，这些错误可能在你的渲染器里没问题，但换个渲染器就出锅了（建议使用 vscode 的安装一个 markdownlint 的插件）:

    1. 裸链接

      请使用<>包裹起来！比如<https://mechax.rtfd.io>显示为https://s.0reg.cf/。

      上面这行没打错啊，我故意的。

  4. bdg (powered by sphinx_design)

    {bdg-danger}`你今天打卡了么`

    将显示为

    你今天打卡了么

快捷修改或增加文章（推荐）#

考虑到互联网连通性问题，本文档主仓库托管在 CloudFlare CDN 加速的服务器。

因此，首先你需要注册一个 GitLab 账号。如果你已有 GitHub 账号，可以快速登录。

单击页面标题右侧的笔符号，根据提示进行 fork ，编辑完成后修改 commit message 为 update: update xxx.md 或 add: add xxx.md 字样。

最后提交 Pull Request。

本地进行编辑和预览#

请在运行环境里安装 git 和 python3 。你也可以自行配置一个 python venv，考虑到互联网连通性不提供 devcontainer.json 方案。

请你自行在 Gitlab（推荐） 或 GitHub 创建一个仓库分支，然后git clone/add/commit。最后提交 Pull Request。

运行环境内可以使用./server.sh脚本快速安装文档生成依赖，同时启用文档热重载。

你既然都看到这里了……#

你知道吗？Read the Docs平台会将整个文档同时生成为 PDF 和 Epub 文件，点击左侧就可以查看咯！