wiki小项目进程记录

github项目传送门：东西方民间爱情故事 wiki
如果可以，请务必在github上助我一臂之力！ ​ 本人很懒，通核课结束后就已弃置，所以就当留个经验。

1.动手理由

网上 & 书籍中关于世界各地的民间、神话故事大多杂而分散，想要入门了解、对比异同时往往不方便。

因此，借着通核课研究课题“东西方民间爱情故事”的机会，对世界各地相关的爱情故事进行粗略整合，便于入门、举一反三，减少入门门槛 & 查资料时间。

2.基础配置简介

网站基本架构使用的是基于mkdocs的第三方theme：mkdocs-material。

灵感来源：OI Wiki - OI Wiki (oi-wiki.org)。

配置过程：

• pip下载mkdocs：Getting Started - MkDocs

• theme配置：

  mkdocs自带了两个theme，也可以配置第三方theme：
  Choosing Your Theme - MkDocs

  mkdocs - material：
  Installation - Material for MkDocs (squidfunk.github.io)

3.查找资料

主要资料皆收集自维基百科，部分（如中国民间故事）参考百度百科。本人时间精力有限，暂时没法在网上广查资料 & 进行进一步精化。

整理多少放多少。

4.准备

• 网站服务器：依然基于 Github Pages。
• wiki网站架构：mkdocs - material，见上。

5.网站个性化

着重讲一些个人遇到的麻烦，简单的详见官网指南——反正新手大部分都是在mkdocs.yml上折腾。

• 全面详尽の官方指南：Setup - Material for MkDocs (squidfunk.github.io)
• 如果要按照指南，进行更细节的复写override，.md文件等还是照常添加到/docs文件夹里的。

网站 logo & favicon

图标生成网站：Favicon Generator for perfect icons on all browsers (realfavicongenerator.net)

• 图片文件要放在正确的路径下：

github 相关设置

仓库

• build & deployment的原理和jekyll - chripy略有不同：
  • jekyll - chripy是全程使用github actions搞定；
  • mkdocs官方指南中，是先使用github actions让bot生成一个gh-pages分支，再基于该分支中的文件内容建设、发布网页。

so，settings中配置是这样的：

workflow 设置

Publishing your site - Material for MkDocs (squidfunk.github.io)

结合上述经验后，照搬教程即可。

设置 .gitignore 文件忽略本地 /site 中的更改

每次在本地执行 mkdocs build 后，Git 就会追踪到存储库中更新的 /site 静态网站文件夹中的所有更改 & 挂起，看着那几十个不需要提交的更改挂在 VS Code 上，神烦！

设置 .gitignore 文件可以拯救我们——它能指定哪些文件不用被 Git 追踪。

• 官方讲解：gitignore Documentation - Git

• 具体文件内容规则（简洁举例.ver）：

  1. 排除单个文件：

     filename.txt

  2. 排除特定目录：

     foldername/

  3. 使用通配符排除一类文件，比如排除所有.log结尾的文件：

     *.log

  4. 使用通配符排除特定模式的文件，比如排除以temp开头的.txt文件：

     temp*.txt

  5. 排除特定扩展名的文件：

     *.exe

  6. 排除特定目录下的所有文件：

     /path/to/directory/*

  7. 排除特定目录及其所有子目录：

     /path/to/directory/

  8. 排除文件中的注释行或空行（虽然不是必需的，但有时可以提高可读性）。

     请注意，.gitignore文件中的每一行表示一个排除规则，可以是文件名、目录名、通配符模式等。