我们欢迎任何建设性的贡献。小到修正标点符号、错别字,大到写下一小篇文章甚至一整章,只要是帮助建设本仓库的,我们都非常欢迎。
本文章假定用户有一定的 Git 使用基础(例如,知道 Git 和 GitHub 的区别),同时至少能使用 Markdown 或者 LATEX。
本项目其实是用 pdfLaTeX 构建的,Markdown 被拿来通过 Pandoc 转化为 LaTeX 并添加入最终的预构建文档。为了防止过多的冲突,我目前使用这样的约定:
章(Chapter)为一个大的模块 / 领域,包括了若干个节(Section),每节都是一篇完整的对该领域一个小方向 / 知识点的描述 / 说明 / 讲解。
每一章为一个文件夹,文件夹以该章主题命名,空格分词,每单词首字母大写。每一节为一个文件,文件以该节主题命名,不分词,大驼峰式命名。
在最终的文档中添加相关章节的方式为,修改仓库根目录下的 build.sh
文件夹,在底部的 Write book
段落中按照顺序添加对应的文章。
-
如果是 LATEX 的话,添加的形式为:
includetex "<Chapter Name>/" SectionName
例如:
includetex "Basic Math/" ChapterIntro
-
如果是 Markdown 的话,添加的形式为:
includemd "<Chapter Name>/" SectionName
例如:
includemd "Deep Learning/" Classification
<Chapter Name>
被用来查找文件夹,SectionName
则直接指向文件(注意不需要带扩展名)。
建议每一章都以一个 LATEX 格式的 ChapterIntro
开头,在其中使用 \chapter{}
命令。(Markdown 的 Pandoc 自动转换好像没法做到这个)。
最后不要忘了在根目录下的 cover.tex
的 \author{}
命令和 README.md
的底部添加尊姓大名~
待补充。