如何写好一个实验指导网站 ¶
约 270 个字 预计阅读时间 1 分钟
正如我在首页中说到:
但由于大部分助教缺乏对 markdown 规范的阅读、缺乏对于 mkdocs/material 文档的阅读、缺乏一些基础的文字排版知识,导致制作出来的实验文档虽然能用,但对于“完美主义者”来讲体验极其糟糕。
所以本文档的主体结构就是针对这三个方面,即:
- 「重修 markdown !
」 :一些 markdown 易错用法集锦 - 「去读各个文档 !
」 :关于文档网站设置的一些建议 - 「多少学点排版
」 :一些排版基础,主要是中西文混排中的标点符号使用规范
根据一整套工作流会用到各页面内容的时间顺序,推荐的阅读顺序如下:
- 配置网站框架:mkdocs 配置拾遗 & material 主题使用拾遗 & markdown 扩展配置拾遗
- 编写 markdown 内容:markdown 常见错误用法集锦 & 标点符号的使用
- 优化源码 / 样式效果:其他 markdown 编写建议 & 更多排版建议