欢迎来到星火内部开发者文档中心,为了之后更加高效的工作,了解彼此的工作,请大家将自己所管辖的工作以文档的方式写下来,包括但不限于工作规范,工作流程,工作思路,服务器ip地址
若未安装 Git,请安装:sudo apt install git -y
。
在刚刚 Fork 的自己的仓库的右上角的克隆/下载
中选择复制
。
在希望下载的位置右键在终端打开,这里例子是桌面,输入 git clone 你复制的地址
,然后回车。
克隆完毕后,进入Spark-Wiki/docs
目录,对需要的文件进行编辑。
在对应的目录新增文件名.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)
推荐使用小书匠 Markdown 编辑器进行编辑,较为适合新手使用。
安装命令行工具
npm i -g docsify-cli
启动本地服务器
docsify serve docs
回到 Spark-Wiki
目录,在终端中打开。
使用:
git add .
git commit -m 更新文档
如果你是首次使用git,系统会提示你配置用户名和邮箱,按照系统提示复制粘贴指令,填写即可。如果你不是首次使用,系统应该不会提示异常。
然后
git push
根据系统提示输入你的码云用户名/邮箱和密码即可完成提交。
回到你的仓库网页,点击这里。
然后等待星火商店开发组进行审核和合并即可。
分类对应表是
分类 | 文件夹 |
---|---|
软件投递 | Submit |
软件管理 | Manage |
储存与同步 | Storage |
分发 | Distribution |
协作指南 | Collaborate |
编者注:以下内容参考自针对 MDN 文档的本地化指南
除了代码中使用的符号以及一些特殊情况外,请始终使用中文(大部分为全角)符号。
同时在大多数情况下,每句末尾都应当添加标点符号。
但请注意,请不要使用全角数字(特殊情况除外)。 示例如下:
另外,请注意并列的词语间应使用顿号而非逗号:
名称 | 中文 | 英文 |
---|---|---|
括号 | () | () |
冒号 | : | : |
引号 | “” | "" |
破折号 | —— | -- 、 — |
简体中文标点符号参考资源:
对于简体中文文档,请在中文和拉丁语系文字之间保留一个空格,但在拉丁语系文字和中文标点之间,则无需保留空格。
示例如下:
对于链接文字和非链接文字部分,同样适用此规则:
它指向一个[示例](#示例)
它指向一个 [示例](#示例)
指向 [MDN 开发者文档](https://developer.mozilla.org/)的链接
指向[MDN开发者文档](https://developer.mozilla.org/)的链接
请注意,数字与中文之间也请保留空格:
对于任何专有名词,特别是操作系统名称,请使用它最广为人知的形式:
Ubuntu
、Debian
UOS
deepin
GitHub
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。