跳到主要内容

编写规范

如果你愿意为 BukuWiki 提供新的内容,请务必认真查看下面的编写规范,我们在审核 PR 的时候会按照规范,严重不符将会被拒,谢谢配合。

  1. BukuWiki 不欢迎 通篇 的 AI 内容,可以在片段使用AI简单编写,至少不能让整个文档都充斥着 AI 文。

  2. 建议在 中英文和数字之间 插入空格,这样能让文档阅读更舒服一点。我们已经在前端加入了 pangu 进行纠正,但我们希望各位创作者要在适宜处插入空格,以便于阅读。

  3. 但是最好不要在 中文和中文之间 插入空格,如 "张三今天 发了 一个维 基",这样只会让阅读体验下降。如果是 专用名词或特别强调处 则可以加入空格以便区分,例如:我们则需要用到 联机模块

  4. 如果你需要新建目录或新的章节,请务必按照已有的风格创建,简单明了,便于其他创作者阅读或编辑。

  5. 所有的md要用到的图片或特定资源,均放在其目录下的 assets 文件夹下,文件命名需要写出文件的用处,例如 PCL 2 启动器的首页,你可以这么命名它的图片 pcl2-home-page

  6. 上传图片可以选择 avifwebp 易于传播的图片格式。当然,普通的 png 也可以,我们为你准备好了 ImgBot 来尽最大可能优化图片大小以方便传播,但前者更适合。

  7. 善用 Markdown 语法,重要内容可以加粗处理,引用内容要使用引用语法,对于一些无关紧要的说明,或者只是一些吐槽,可以用倾斜语法。

如果你需要更改或新增文档内容,我们已经为你们准备好了 MarkDown 检查工具,请务必在提交之前检查你的文档书写。直接运行 format:check 就能检查你的书写,他会告诉你有哪些部分未按照标准书写,你可以选择手动修复它们,也可以选择运行 format 尝试自动修复。

请注意,你的每次 PR 都要对你自己负责,所以在提交新的内容之前,请务必本地构建测试,认真检查类似于错别字的内容之后,再提交 PR 。不管是低质量的内容,还是不符合规范的内容,请你仔细斟酌。

最后,感谢所有为 BukuWiki 的贡献者,是你们一起完成了这份有意义的 Wiki ,谢谢你们!