diff --git a/docs/general/coding_convention.md b/docs/general/coding_convention.md index e581993..6815b3c 100644 --- a/docs/general/coding_convention.md +++ b/docs/general/coding_convention.md @@ -23,7 +23,6 @@ no_comments: true - 不要编写的过于详细或过于简略; - 可以采用一些格式,例如 [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#examples); - 不掺杂个人情绪; - - 用户名和邮箱应该配置成自己的真实姓名和邮箱; - 可以添加一些 Emoji,[gitmoji](https://gitmoji.dev/) 为提交说明中使用的 Emoji 提出了一些建议,可以参考。 ## 代码风格 @@ -33,7 +32,7 @@ no_comments: true 保证代码的简洁: - 有整齐的缩进,建议用空格缩进而非 tab,两个空格或者四个空格作为一级缩进都可以; - - 每一行不要有太多字符,例如不超过 80 / 100 个字符; + - 每一行不要有太多字符,例如不超过 80 - 100 个字符; === "注释" @@ -50,7 +49,7 @@ no_comments: true 代码中应该有适当的空格和空行: - 函数中,实现不同功能的代码间需要添加空行; - - 操作符前后应该有空格,例如 c = a + b; + - 操作符前后应该有空格,例如 `c = a + b`; - 保持前后一致的风格。 === "命名" diff --git a/docs/index.md b/docs/index.md index 8ad9da4..02502ca 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,3 @@ ---- -no_comments: true ---- - # 中山大学 YatSenOS v2 操作系统实验教程 ## 实验说明 diff --git a/overrides/partials/comments.html b/docs/overrides/partials/comments.html similarity index 100% rename from overrides/partials/comments.html rename to docs/overrides/partials/comments.html diff --git a/mkdocs.yml b/mkdocs.yml index 3c62b1c..f55d5c7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,7 +5,7 @@ repo_name: YatSenOS-Tutorial-Volume-2 theme: name: material - custom_dir: overrides + custom_dir: docs/overrides language: zh palette: - media: "(prefers-color-scheme: light)"