本文档旨在提供关于文档格式的指导,帮助您更好地理解和遵循本站的文档编写规范。

文档结构

  • 标题:使用清晰、简洁的标题,概括文档内容。
  • 正文:正文内容应结构清晰,逻辑严谨。
  • 代码示例:如果文档中包含代码示例,请确保代码格式规范,并添加必要的注释。

语言风格

  • 中文:使用规范的中文语法和表达方式。
  • 英文:使用标准的英文语法和表达方式。

图片规范

  • 图片应与文档内容相关,并添加必要的说明文字。
  • 图片格式支持:jpg, png, gif。

链接规范

  • 内部链接:使用斜杠开头,如 /docs/guidelines
  • 外部链接:使用 http://https:// 开头。

示例

以下是一个示例:

## 示例代码

```python
def hello_world():
    print("Hello, world!")
def hello_world():
    print("Hello, world!")

扩展阅读

想要了解更多关于Markdown的编写规范,请访问Markdown官方文档

图片示例

(center) Golden_Retriever (center)