# Spark-Wiki 

**Repository Path**: spark-store-project/Spark-Wiki

## Basic Information

- **Project Name**: Spark-Wiki 
- **Description**: Spark-Wiki 
- **Primary Language**: Unknown
- **License**: CC-BY-SA-4.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 5
- **Created**: 2022-11-21
- **Last Updated**: 2025-06-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 星火开发者文档中心

欢迎来到星火内部开发者文档中心，为了之后更加高效的工作，了解彼此的工作，请大家将自己所管辖的工作以文档的方式写下来，包括但不限于工作规范、工作流程、工作思路、服务器 IP 地址等。

## 如何贡献

### 1. Fork 本仓库 https://gitee.com/spark-store-project/Spark-Wiki

![仓库首页，标出了 Fork 按钮的位置](https://xiaoshujiang-shenmo.oss-accelerate.aliyuncs.com/小书匠/1669012094633.png)

### 2. 在自己的仓库中新增或者修改内容（格式为 Markdown 格式）

若未安装 Git，请安装：`sudo apt install git -y`。

在刚刚 **Fork 的自己的仓库的右上角**的`克隆/下载`中选择`复制`。

![Fork 后的仓库首页，标出了『克隆/下载』中的『复制』按钮](https://xiaoshujiang-shenmo.oss-accelerate.aliyuncs.com/小书匠/1669012317476.png)


在希望下载的位置点按鼠标右键，选择“在终端打开”（这里例子是桌面），输入 `git clone 你复制的地址`，然后回车。

![终端页面，同时有示例 Git 命令](https://xiaoshujiang-shenmo.oss-accelerate.aliyuncs.com/小书匠/1669012394787.png)
克隆完毕后，进入`Spark-Wiki/docs`目录，对需要的文件进行编辑。

#### 新增内容方法

在对应的目录新增`文件名.md` 之后，在 `docs` 目录下的 `_siDebar.md` 仿照已有条目编写，将自己的文件添加进去。

---

举例，假如要在`分发`分类下新增了`山东大学镜像站`条目，文件位置放在了 `Distribution/sdu-mirror.md`。

原本的条目：

```markdown
* 分发
* [概述](/Distribution/README.md)
* [需要考虑的](/Distribution/Consideration.md)
* [Deb分发方案](/Distribution/Proposal.md)
```
应该修改为：

```markdown
* 分发
* [概述](/Distribution/README.md)
* [山东大学镜像站](/Distribution/sdu-mirror.md)
* [需要考虑的](/Distribution/Consideration.md)
* [Deb分发方案](/Distribution/Proposal.md)
```
---



推荐使用小书匠 Markdown 编辑器进行编辑，较为适合新手使用。

### 3. 本地预览

安装命令行工具

```shell
npm i -g docsify-cli
```

启动本地服务器

```shell
docsify serve docs
```

### 4. 保存并提交到自己的仓库

回到 `Spark-Wiki` 目录，在终端中打开。

使用：

```bash
git add .
git commit -m 更新文档
```

如果你是首次使用 Git，系统会提示你配置用户名和邮箱，按照系统提示复制粘贴指令，填写即可。如果你不是首次使用，系统应该不会提示异常。

然后

```bash
git push
```

根据系统提示输入你的码云用户名/邮箱和密码即可完成提交。


### 5. 创建拉取请求

回到你的仓库网页，点击这里。

![PR 标签，并指出了『新建 Pull Request』按钮的位置](https://xiaoshujiang-shenmo.oss-accelerate.aliyuncs.com/小书匠/1669013872692.png)
![新建 PR 的页面及说明](https://xiaoshujiang-shenmo.oss-accelerate.aliyuncs.com/小书匠/1669014081804.png)

然后等待星火商店开发组进行审核和合并即可。

## 分类说明

分类对应表是

| 分类 | 文件夹 |
| ---- | --- |
| 软件投递 | Submit |
| 软件管理 | Manage |
| 储存与同步 | Storage |
| 分发 | Distribution |
| 协作指南 | Collaborate |

## 文档规范

> 编者注：以下内容参考自[针对 MDN 文档的本地化指南](https://github.com/mdn/translated-content/blob/main/docs/zh-cn/translation-guide.md)

### 标点符号

除了代码中使用的符号以及一些特殊情况外，请始终使用中文（大部分为全角）符号。

同时在大多数情况下，每句末尾都应当添加标点符号。

> 但请注意，请不要使用**全角数字**（特殊情况除外）。
示例如下：

- 正确：我们可以学习 JavaScript——一种很酷的语言
- 错误：我们可以学习 JavaScript--一种很酷的语言
- 正确：以下示例是“可交互的”
- 错误：以下示例是"可交互的"

另外，请注意并列的词语间应使用顿号而非逗号：

- 宜：a、b 和 c
- 不宜：a，b，和 c

#### 常见中/英文标点

| 名称 | 中文 | 英文 |
| ---- | --- | ---- |
| 括号 | （） | ()   |
| 冒号 | ：   | :    |
| 引号 | “”   | ""   |
| 破折号 | —— | -- 、 — |

简体中文标点符号参考资源：

- [教育部《标点符号用法》](https://www.moe.gov.cn/ewebeditor/uploadfile/2015/01/13/20150113091548267.pdf)
- [维基百科：标点符号](https://zh.wikipedia.org/zh-cn/标点符号)

### 中文和拉丁语系文字间加空格

对于简体中文文档，请在中文和拉丁语系文字之间保留**一个空格**，但在拉丁语系文字和中文标点之间，则无需保留空格。

示例如下：

- 正确：学习 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`

## 感谢

**[docsify](https://github.com/docsifyjs/docsify)**