Skip to content

如何编辑内容与提出意见

前言 本网站的运行结构

本书的文字内容以markdown的源代码格式托管于gitlab代码仓库,构建出的网页目标代码使用gitlab page进行传播。

本网站基于vitepress进行开发,vitepress是一个将markdown源代码变成网页的工具。

Markdown 示例

Markdown是一种对人类有很好的可读性同时对机器解析也很友好纯文本格式

  • Markdown 对人类有很好的可读性: Markdown可以让一个 从未接触Markdown的新手 也可以进行缝缝补补式的小段编辑。

  • Markdown 对机器解析友好: 以Markdown格式编写的文件可导出为HTML(网页文件)、PDF等多种易于传播的形式。

例如,在Word中,我们可以选中一段文本,调整它的字号/颜色/大纲层级等等信息,在Word中,文本样式大纲结构是紧密结合不可分离的。

而在Markdown中,我们在文本旁边添加一些小小的标记符号,比如:

# 这是一级标题

## 这是二级标题

**这是粗体**

*这是斜体*

# ## ** * 都是Markdown中有规定的标记,他们经由计算机处理后将会被渲染为:

这是一级标题

这是粗体

这是斜体

本书的每个小节都用Markdown语法写成了单独的文件,并用特定的文件目录结构存放在网络服务器上。通过名为vitepress的软件,将这些Markdown文件转换为一个可以被用户访问的美观的网站。这个网站是个静态网站,它无需程序员自己提供后台服务器。文档编译成网页、pdf的工作是由gitlab ci(流水线)提供的,网络请求的运行是由gitlab pages所提供的。

通过社交媒体联系作者们

以下是一些作者的联系方式,你可以通过这些渠道来提出意见或建议:

在 Gitlab 上编辑和提出意见 建议经常编辑的人使用

在 Gitlab 提出意见

如果你已经 注册好了 Gitlab 账号 ,你可以在 Gitlab 新建议题 处提出意见建议,而且可以指定处理的人。

即便你没有注册账号,你也可以在 Gitlab 议题 处看看别人提出了啥意见。

在 Gitlab 在线编辑

为什么选择 Gitlab

Gitlab 和 Git 都是公开源代码的、久经考验的、受全世界程序员信任的开源软件。

  • Git 是一个版本管理软件。它可以让每个人修改自己本地的分支线而后顺利的合并到主线。 因此它是去中心化的,不会被少数人控制;Git 使用哈希签名的机制保证能轻易的检查到数据的修改。了解更多 →

Gitlab 有很多额外的功能,非常便于版本管理。

  • Gitlab 的 流水线 可以在内容修改之后自动生成最新版的网页和 PDF 文件。

  • Gitlab 的 议题 功能可以用来收集反馈意见。

  • Gitlab 的 提交仓库图 功能也能清晰明了的展示内容的变化。

在 Gitlab 直接编辑

你可以在 Gitlab 上注册账号并直接编辑

  1. 在 Gitlab 注册一个账号 非常简单,只需要使用一个用于验证的邮箱。而且 Gitlab 的汉化做的很棒。

    • (如果已经注册,或是朋友帮助注册了,请跳过此步。)
  2. 在你注册好账号之后,点击“编辑或提出意见”后的“来源跳转”中的高亮链接即可跳转到 Gitlab 的对应的文件。然后点击编辑按钮,会提示你并不能直接编辑,需要“派生”(Fork)。

    • 这是因为你当然不能直接编辑我的仓库,你得复制一个自己的然后修改自己的。

  3. 聪明的你只需要继续一步一步点点点,就可以 Fork 出自己的仓库。

  4. 随后 Gitlab 会让你修改内容。当你修改完成时点击保存时,Gitlab 会自动帮你提交一个“推送派生到主仓库”的申请。我们就填一些描述信息然后确定就行。

接下来只需要等待我们的管理员进行审核即可应用你的提交了。