Skip to main content

A-Soul 上网冲浪编辑指北

为了防止指南被严重破坏，以及帮助对静态页面没有编辑经验的新成员，我制定了 这一份 A-Soul 上网冲浪指北 来规范指南的编辑。

如果你只想提交内容...#

因为网站编辑需要的门槛较高，如果你只是想写新条目，我们现在提供下述方法：

你可以点击 GitHub 上方 issues 页面，点击右边的 New issues 绿色按钮。在弹出的新菜单中， 选择新条目选项，你会看到一个页面编辑框，请在标题的 “【新条目】” 后方空一格，填写你要补充的内容名字。

最后点击右下角的 Submit new issues 按钮提交即可，我们会在有空的时候增加内容。

在你贡献之前...#

由于我们的内容审核和版本管理依赖 git, 如果你想对我们仓库直接修改，不论你是想编辑内容还是维护网站，你都 需要了解 git 和 GitHub Pull Request 的使用方法。

修改前依照如下步骤进行贡献：

  1. fork 仓库

点击右上角的 fork 按钮将该仓库 fork 到你的账户下。

  1. 拉取仓库到本地并编辑

拉取仓库:

git clone https://github.com/{{你的用户名}}/ASoul-Surfing-Guide

新建分支：

git checkout -b {{NEW_CHANGE}}
# 例子
git checkout -b new-artical

然后再对文件进行编辑， 编辑时请同时请注意几点：

  • 请不要编辑 README.md。
  • 如果你是内容编辑人员，请在 ./docs 文件夹内工作，不要编辑其他文件
  • 如果有必要编辑网站的设置，请先发起 issues 进行讨论。
  • 请不要编辑 LICENSE.txt
  1. 提交
git add . && git commit -m "你做了什么修改"
git push origin master
  1. 提交 PR

点击 Pull Request, 将分支提交到这个仓库。

你想做什么#

内容维护#

内容维护并不像在评论区写小作文那样愉悦，我们对指南的内容准确及严谨程度有一定 的要求。

目录：

内容编辑要求#

  1. 请使用 Markdown 格式编辑。

如对 Markdown 语法不熟悉，可以查看这篇文章： Markdown语法教程

Markdown 编辑器如何选择我们没有限制，你可以任意选取，如果你是第一次使用你可以尝试 typora。 但是本人推荐使用 VSCode 加上预览插件， 可以方便的进行版本管理，也可以对文本样式的实现有清晰的了解。

  1. 请使用如下格式进行百科内容编辑(请注意换行是两次回车)
# 梗名字 （比如“含金量”）
## 来源
梗的来源 （可以是直接的视频地址，或者文字解释渊源。）
## 变体
梗的一些变体 （比如 “知道顶碗人的含金量吗”）
## 语义
这个梗是什么意思，是贬义还是褒义
## 应用
梗的使用范例。
  1. 请使用正确的中英文文案编辑格式

请查看 中文文案排版指北 并依照文章规范进行文案编辑。

  1. Commit 的信息必须直观准确

请对每一次修改都进行 commit，不要一次性提交上百行的修改。同时你应该给自己 每一次修改都标注上清晰明了的修改注释。你的 commit 应该能完整的概括你此次修改 的内容。

如果对如何编写清晰的 commit 没有头绪，你可以参考下面的模板：

<type>(optional text): <descriptions>
- type: 修改类型
- optional text: 对修改类型的一些补充
- descriptions: 本次修改的信息

例子：

  • 修改了一些语法错误：
git commit -m "订正： 修复了圣嘉然条目的语法错误"
  • 增加了新的条目：
git commit -m "更新： 新增 “欧系给” 条目"
  • 对条目进行了一些补充：
git commit -m "更新(引用补充): 补充了向晚资料页的引用文章地址"

可以参考下列网站来获得更详细描述：

  1. （推荐，可选） 一些编辑建议
  • 本人推荐每隔 80 个字符即换行。非中文字数，而是字符。使用 VSCode 或者 Vim 可以方便查阅。
  • 推荐在自己编辑的内容页上方使用注释标注作者姓名。
  • 所有的条目都最好有来源地址，可以是梗出现的帖子，也可以是视频 URL。

内容编辑教程#

文件结构#

条目都应该放在 docs 文件夹下， 并对你的条目进行分类, 放进次级文件夹里，还可以继续 给条目分类，比如： 含金量可以属于 LOL 分类，同时 LOL 属于电竞分类，那么你的条目就应该 放在：

docs/
|--电竞/
|--LOL/
|--含金量.md

文件抬头#

在 markdown 文件的开头加入两个 --- 来加入对这个文件的更多描述。

为了声明你的条目编辑名义权，我推荐你在条目的抬头备注上你的名字。不要写真名，请注意 保护隐私，写上昵称就可以了。也可以附注电子邮箱。

用如下例子的格式进行编写，即 YAML 语法：

Author: Avava Ava(example@example.com)

其次，请附注创建日期以及最后一次编辑日期：

CreateAt: '2021/06/07 13:30'
LastEditAt: '2021/06/08 14:28'

请务必写上文章的标题：

title: 口水黄豆

如果你愿意，加上该条目的描述就更加完美了：

descriptions: 口水黄豆是顶碗人很喜欢用的一个表情...

最后你可以再加上一些标签帮助别人找到这个条目（不要加太多，一定要相关）：

keywords:
- 向晚
- 下雨了
- 口水黄豆

完成后你的文件应该像这样：

---
Author: Avava Ava(example@example.com)
CreateAt: '2021/06/07 13:30'
LastEditAt: '2021/06/08 14:28'
title: 口水黄豆
descriptions: 口水黄豆是顶碗人很喜欢用的一个表情...
keywords:
- 向晚
- 下雨了
- 口水黄豆
---
# 口水黄豆
## 来源
正文...

提交修改#

修改完之后你需要使用 git 把修改存好并提交到你自己的仓库，然后在 GitHub 发起 Pull Request 请求，我们会尽快检查你的文字并合并到网站中。

git add ./docs/口水黄豆.md
git commit -m "更新： 新增口水黄豆条目"
git push origin master
Last updated on by Avimitin