网站内容校验 - sofastack/sofastack.tech GitHub Wiki

为了保证网站内容的高质量,在每次对网站内容变更时需要对网站内容进行校验,主要检测以下内容:

  • Hugo 模板与语法校验:检测文章的头部 Hugo 模板配置。
  • HTML 校验:若网站可以正确编译,检测 HTML 中的链接、格式错误等,使用开源的 html-proofer 完成。
  • Markdown 语法校验:新提交的文档中的 Markdown 语法错误
  • 拼写检查:检查新提交的文章中的拼写错误

你可以选择在本地执行,也可以通过 CI 在提交 PR 时自动触发。

本地执行

在网站代码中已经包含了校验的脚本,使用下面的命令可以自动校验:

make install
make build
nohup make lint > .htmlproofer/lint-result.md 2>&1 &

打开 .htmlproofer/lint-result.md 文件就可以看到校验后的结果。