4.5 KiB
4.5 KiB
文档中心
新增内容方法
在对应的目录新增文件名.md 之后，在 docs 目录下的 _siDebar.md 仿照已有条目编写，将自己的文件添加进去。
举例，假如要在分发分类下新增了山东大学镜像站条目，文件位置放在了 Distribution/sdu-mirror.md。
原本的条目：
* 分发
* [概述](/Distribution/README.md)
* [需要考虑的](/Distribution/Consideration.md)
* [Deb分发方案](/Distribution/Proposal.md)
应该修改为：
* 分发
* [概述](/Distribution/README.md)
* [山东大学镜像站](/Distribution/sdu-mirror.md)
* [需要考虑的](/Distribution/Consideration.md)
* [Deb分发方案](/Distribution/Proposal.md)
3. 本地预览
安装命令行工具
npm i -g docsify-cli
启动本地服务器
docsify serve docs
4. 保存并提交到自己的仓库
回到仓库目录，在终端中打开。
使用：
git add .
git commit -m 更新文档
如果你是首次使用 Git，系统会提示你配置用户名和邮箱，按照系统提示复制粘贴指令，填写即可。如果你不是首次使用，系统应该不会提示异常。
然后
git push
根据系统提示输入你的码云用户名/邮箱和密码即可完成提交。
5. 创建拉取请求
回到你的仓库网页，点击这里。
然后等待星火商店开发组进行审核和合并即可。
分类说明
分类对应表是
| 分类 | 文件夹 |
|---|---|
| 软件投递 | Submit |
| 软件管理 | Manage |
| 储存与同步 | Storage |
| 分发 | Distribution |
| 协作指南 | Collaborate |
文档规范
编者注：以下内容参考自针对 MDN 文档的本地化指南
标点符号
除了代码中使用的符号以及一些特殊情况外，请始终使用中文（大部分为全角）符号。
同时在大多数情况下，每句末尾都应当添加标点符号。
但请注意，请不要使用全角数字（特殊情况除外）。 示例如下：
- 正确：我们可以学习 JavaScript——一种很酷的语言
- 错误：我们可以学习 JavaScript--一种很酷的语言
- 正确：以下示例是“可交互的”
- 错误：以下示例是"可交互的"
另外，请注意并列的词语间应使用顿号而非逗号：
- 宜：a、b 和 c
- 不宜：a，b，和 c
常见中/英文标点
| 名称 | 中文 | 英文 |
|---|---|---|
| 括号 | （） | () |
| 冒号 | ： | : |
| 引号 | “” | "" |
| 破折号 | —— | -- 、 — |
简体中文标点符号参考资源：
中文和拉丁语系文字间加空格
对于简体中文文档，请在中文和拉丁语系文字之间保留一个空格，但在拉丁语系文字和中文标点之间，则无需保留空格。
示例如下：
- 正确：学习 Web 开发
- 错误：学习Web开发
- 正确：学习 JavaScript、HTML、CSS 等
- 错误：学习 JavaScript、 HTML、 CSS 等
- 正确：应用程序接口（API）
- 错误：应用程序接口（ API ）
对于链接文字和非链接文字部分，同样适用此规则：
- 正确：
它指向一个[示例](#示例) - 错误：
它指向一个 [示例](#示例) - 正确：
指向 [MDN 开发者文档](https://developer.mozilla.org/)的链接 - 错误：
指向[MDN开发者文档](https://developer.mozilla.org/)的链接
请注意，数字与中文之间也请保留空格：
- 正确：需 10 个小时完成
- 错误：需10个小时完成
英文专有名词
对于任何专有名词，特别是操作系统名称，请使用它最广为人知的形式：
- 一般来说是一个首字母大写的英文单词，如
Ubuntu、Debian - 也有全大写的名称，如
UOS - 全小写的名称极少，请谨慎使用，如
deepin - 另有特立独行的一个单词中出现多个大写字母的也请保持原样，如
GitHub