跳转至

贡献指南

您可以任选以下几种方式以贡献内容:

评论区留言

对于正文:请在 您想投稿的页面 下方评论区进行留言。如无对应页面,请在 本页 评论区下方留言。

对于布局建议:如果您想增、删、调、改某一板块或页面,请在 本页 评论区下方留言。

发送邮件

请将邮件发送至 chiyoyuki.uk@gmail.com,为了更高效地处理邮件内容,我们建议(而非强制要求)您采用如下格式:

  • 邮件标题:东师附中生存手册投稿+投稿内容简述

  • 邮件正文:

  • 作者署名(可为真名或昵称,若无则为匿名)
  • 投稿内容所在板块,以及推荐的位置(例如在某一文章之后,某两篇文章之间等)

  • 邮件附件:压缩包,教程文件,请无论是否仅含有一个文件,均使用压缩包,其中包含以下内容:

  • 文档正文:使用 Markdown(.md)或 word(.doc/.docx)进行撰写。
  • 图片文件夹:包含所使用的全部插图的源文件,静态图片请使用 .jpeg/.jpg/.png/.webp 格式,动态图片请使用 .gif 格式。若无插图,则无需此文件夹。

  • 视频方面:若您需要插入视频,请给出视频链接,暂不支持视频文件

维护者收到投稿后会基于人工的回信,后续可能通过邮件进行关于投稿的讨论。

Github

若采用此方法,您应 - 掌握 git 的基本操作 - 拥有一个 Github 帐号 - 知道一些可以稳定连接 Github 的方法 - 可以使用 Markdown 语言进行文档编辑

本手册markdown源文件位于master分支./docs文件夹下

  • 对现有页面进行更改

  • 参考./mkdocs.yml文件中最下方nav目录栏

  • ./docs文件夹及其子文件夹中找到您要修改页面的.md文件并编辑。
  • 如有图片,请将图片放入./docs/pics文件夹内。
  • ./docs/intro/thanks.md文件中标注您的贡献内容(也可匿名,但不推荐)
  • 修改完成后保存并提出pr。

  • 新增页面、板块

  • 请在./docs文件夹中新建.md文件并编写。

  • 如有图片,请将图片放入./docs/pics文件夹内。
  • 编写完成后,依照您对它的认知放入对应板块的文件夹中,如无对应板块,可新建一板块文件夹。
  • 修改./mkdocs.yml文件最下方的nav以调整目录。
  • ./docs/intro/thanks.md文件中标注您的贡献内容(也可匿名,但不推荐)
  • 修改完成后保存并提出pr。
文件名

文件名最好仅包含小写英文字母、数字及减号'-'

盒!

如果您知道该手册是谁在维护,您可以直接让他代为编辑。

评论区