文档贡献
大约 2 分钟
文档贡献指南
星辰之光文档网络是一个公开的、任何人都可以提交修改的文档网络。
我们使用 VuePress v2[1] 和 VuePress Theme Hope[2] 搭建这个文档网络。
所以，若您想要为文档网络做出贡献，您需要对 Markdown 格式有所了解。
贡献前准备
在继续前，您需要准备以下软件
- Git[3]
我们的文档网络基于它构建。 - Node.js®[4]
我们的文档网络基于它构建，若您不需要实时查看文档效果可以不用。
需要注意的是，如果我们发现您提交的修改中存在问题，我们可能会拒绝您的修改。 - Visual Studio Code®[5]
对于不了解 Markdown 格式的人来说，它没有办法像其他编辑器那样做到所见即所得。
所以您可以选择其他的编辑器而不是这个编辑器来编辑文档。
Markdown
Markdown 并不是一个标准，它只是提供了一种易读易写的纯文本格式使人们可以很方便的编写文档。
由于它不是标准，所以各个不同的渲染器渲染出来的效果也会有所不同。
不同的语法解释器所支持的语法也会有所不同。
我们的文档网络基本支持 GFM 格式[6]，以及下列语法。
容器
我们支持一种语法用来为一些内容创建特殊的容器
它的语法是这样的
::: <类型> [<标题>]
<内容>
:::
容器有以下几种类型
| 类型 | 说明 |
|---|---|
| info | 信息 |
| note | 注释 |
| tip | 提示 |
| warning | 警告 |
| danger | 危险 |
| details | 详细信息 |
| tabs | 选项卡 |
| code-tabs | 代码选项卡 |
| left | 左对齐 |
| center | 中间对齐 |
| right | 右对齐 |
| justify | 两端对齐 |
相关信息
这是一条信息
注
这是一条笔记
提示
这是一条提示
注意
这是一条注意事项
警告
这是一条警告
详情
这是一个可被折叠的内容
普通选项卡1
内容
普通选项卡2
内容
代码选项卡1
echo hello
代码选项卡2
echo hello
代码选项卡3
echo hello
左 对 齐
中 间 对 齐
右 对 齐
角标
我们支持一种创建脚本的语法
上角标
H~2~O
H2O
下角标
2^10^
210
其他
关于其他更多内容，您可以去 VuePress Theme Hope[2:1] 的文档处查看。