如何为本指南的建设做出贡献?
Note
本页面面向本指南的贡献者,读者不必关注。
进行贡献的方法
本指南基于Github Pages提供的的静态网站服务,静态网站生成器mkdocs,以及mkdocs的主题material搭建。 考虑到并非所有潜在的贡献者都了解以上工具的使用,在此简单向您介绍如何通过以上的工具为本指南的建设提供帮助。
- 首先,您需要拥有一个GitHub账号,用于向本指南推送您的贡献。GitHub官网:https://github.com/ (GitHub是一个外国网站,你可能需要一点魔法来访问它)
- 您可能需要了解GitHub的基本用法,如果您不甚了解,可以参考链接的推荐教程《CS自学指南》/必学工具/Git
- 之后您可以可以Fork本项目并clone到您的本地,可参照链接的指导:https://docs.github.com/zh/get-started/exploring-projects-on-github/contributing-to-open-source
- 接下来您只需要参考《知识推荐模板》,使用markdown文档格式撰写您的知识推荐,并将其放置在合适的目录下,并在mkdocs.yml文件的nav字段下中创建对其的页面导航,您可以参考已有的页面导航进行配置,也可以参阅:https://mkdocs.org.cn/
- 最后您可以把您的修改发起Pull Request,等待接受后您的贡献就能够生效了。
如何撰写知识推荐?
请各位贡献者在撰写知识推荐页面时,可以参考知识推荐模板中的编写结构,您无需完全按照其中的格式,您可以根据实际需要灵活改变您的编写结构。 推荐您可以在页面上留下您的昵称&访问链接
此外,还请您额外注意知识的层级排布,将知识放置在合适的层级,以便读者可以了解其与其他知识的依赖关系和难度级别。