欢迎阅读关于文档语法规范的说明!以下是编写清晰、结构化文档的关键要素:
1. 基本结构 📄
- 标题层级:使用
#
到######
表示不同层级标题(如#
为一级,##
为二级) - 段落与换行:用空行分隔段落,避免连续文字堆砌
- 列表格式:
- 无序列表:
-
或*
开头 - 有序列表:
1.
开头 - 嵌套列表:缩进两格(
-
)
- 无序列表:
2. 常用元素 🧾
- 强调文本:
- 粗体:
**强调**
- 斜体:
*斜体*
- 粗体:
- 代码块:使用反引号包裹(如:
python
或bash
) - 超链接:
- 内部链接:
[文本](/path)
- 外部链接:
[文本](https://example.com)
- 内部链接:
- 图片插入:
<center><img src="https://cloud-image.ullrai.com/q/文档结构/" alt="文档结构"/></center>
3. 语法示例 ✅
4. 注意事项 ⚠️
- 避免使用过长的段落(建议保持每段 3-5 行)
- 代码示例需标注语言(如
python
或javascript
) - 图片关键词需替换空格为下划线(如
代码编辑器
→代码编辑器
)
需要进一步帮助?随时联系 😊