跳转到内容

内容编写准则

在你编写内容前请阅读此准则

1. Frontmatter相关

Frontmatter是整个md的头,本页参数如下:

md
---
title: 内容编写准则
lang: zh-CN
layout: doc
outline: [2,3]
copyright: true
BV: BV1GJ411x7h7
---

大部分Frontmatter参数都可参考 VitePress 官方文档

我们网站所支持的Frontmatter参数如下:

md
---
<!--可开启当前页面的版权声明,参考本页底部-->
copyright: true

<!--配合<BVideo />可在指定位置插入B站视频,效果如下-->
BV: BV1GJ411x7h7
---

2. 正文相关

2.1 排版

通用规则

  1. 英文字母、阿拉伯数字等非中文字符,不应加空格与中文文本分开
    • 不适用于有特殊规定的专有名词
    • 例如:此命令对Minecraft来说太长了,必须在服务端上安装JEI才能处理。
  2. 全角标点与其他字符之间不必留空格
    • 例如:然而这只是理论。说起来容易做起来难:当时我使用的简易网络完全不适合拿来为这个仪式供应魔力,不仅挤压熔岩需要的压力巨大(需要20000LP启动仪式),抽取熔岩的开支也不小(每产生一格熔岩需要500LP)。
  3. 阿拉伯数字与英文单位之间不必添加空格
    • 例如:理想的装饰建材,能存储50mB的流体。被破坏时仍能保留其中的液体。

详细规则

  1. 对于有顺序性的列表请使用有序列表而不是无序列表

贡献者

页面历史