贡献编写须知¶
银川一中 Wiki 由校友共同维护。动笔前请花两分钟读完本页,让你的贡献更快被采纳。
一、提交方式¶
- 在任意页面右上角点击 铅笔图标,进入 GitHub 在线编辑器。
- 改完填写一句说明 → Propose changes → Create pull request。
- 维护者审核通过后,站点会自动重新构建上线。
不会用 Git?完全没问题
整个过程都在网页里完成,不用安装任何东西。更详细的图文步骤见首页。
二、欢迎写什么¶
鼓励
- 校园生活干货:食堂、住宿、出行、考试节点
- 学习笔记、资料整理
- 老师语录、社团故事、校史回忆
- 对过时或错误信息的订正
不建议
- 人身攻击、不实信息、隐私泄露
- 抄袭他人版权内容
- 与校园无关的广告、引流
三、编写规范要点¶
文件与目录命名¶
- 栏目使用中文目录(如
校园生存指南/),栏目首页命名为index.md。 - 具体页面文件名用小写 + 连字符,如
food-guide.md。
标题层级¶
- 每篇文章只使用一个
#(一级标题),作为页面标题。 - 正文从
##开始逐级递增,不要跳级(例如##之后不要直接写####)。
语言风格¶
- 客观、友善、对事不对人。
- 老师语录等主观栏目,也请保持基本尊重。
图片¶
- 图片放到对应栏目的
images/子目录,用相对路径引用: - 涉及他人肖像,请先征得本人同意。
站内链接¶
- 用相对路径,例如:
[食在校内](../校园生存指南/食在校内.md)
四、Markdown 语法参考¶
本站所有页面用 Markdown 书写。基础语法(标题、列表、链接、图片、表格、代码块……)推荐参考下面这份整理得很完整的中文教程:
本站还支持这些扩展语法
本站基于 MkDocs Material,在标准 Markdown 之上还有不少增强:
!!!注解块:如!!! tip "小贴士"会渲染成带左侧色条的提示框:material-xxx:图标短码(注意用连字符,如pencil-plus而不是pencil_plus)- 代码块一键复制、可折叠区块、标签页等
进阶用法见 Material 官方参考。
注意:两套语法并不完全通用
洛谷上的一些语法(如 ||折叠块||、部分 emoji 写法)在本站不会生效;反之本站的 !!! 注解、图标短码在洛谷也不生效。拿不准时,以本站本地预览为准。
有疑问?欢迎在 GitHub Issues 留言,或直接提 Pull Request。期待你的加入!