这是E志者协会正在筹划的维修手册。
当前使用Zensical构建。
当前,手册分为电脑软件、电脑硬件、电器维修三个部分。设想中,前两个部分由电脑部维护,第三个部分由电器部维护。
手册尚未部署到网站上。如果想要临时查看本文档,或者需要为本文档编写文章,可以遵循以下步骤。
现在可以使用GitHub Pages预览本手册。
手册部署在 EVA Doc 上,cname至上述链接。
如果你是文章编写者,请遵循以下步骤以在本地启用预览。
-
在电脑上部署Python环境,确保安装了
pip,且已经添加进环境变量中 -
运行以下命令:
pip install zensical- 下载本仓库,在仓库路径运行
zensical serve- 访问localhost:8000即可看到文档的预览。
请在对应部分的文件夹中新建文件,文件标题为title.md,请使用简洁的英文。
如果需要写内容相近的系列文章,可在对应部分中再新建文件夹。
用到次数较多的图片可以放置在docs/assets/images/文件夹中。
如果一篇文章有较多图片需要插入,可在对应位置新建一个名为title的文件夹,里面新建一个名为index.md的文件,同时新建一个images文件夹。将需要插入的图片放在里面。(示例:购机指南)
在编写中,你可以参照这个链接使用一些基础 Markdown 不支持的元素。如果有未启用的功能,你可以在仓库中提issue。
在编写完成后,你可以将文章添加至索引中。索引的具体位置:
根目录下的mkdocs.yml文件中的nav字段。
如果你没有添加索引,可在Pull Requests时说明。
如果你需要提交一篇没有编写完成的文章,供他人后续完善,请在文章头部标题下方加入以下提示标签:
!!! example "提示"
本文尚未完成。
© 2025 E志者协会. 本作品采用 CC BY-NC-SA 4.0 许可。