跳转至

格式手册

格式手册

本页规定 AI-PM 的 Markdown 写作规范，请在编写内容时遵守。

文章结构

每篇文章以 YAML frontmatter 开头：

1
2
3
---
author: your-github-id  # 可选：你的 GitHub ID
---

标题层级

  • 文章标题使用 ##（# 留给站点标题）
  • 小节使用 ###，子小节使用 ####
  • 避免跳级（如 ## 后直接 ####）

文本格式

  • 加粗：强调关键概念，如 RAG、Agent
  • 行内代码：代码、命令、参数名
  • 代码块：指明语言，如 ```python
  • 中文使用全角标点，英文与数字使用半角
  • 中文与英文/数字之间留一个空格

引用与标注

  • 重要提醒使用 admonition：

    1
2
    ???+ note "提示"
    这是提示内容。

  • 常见类型：note、warning、tip、example

  • 引用外部资料时附上链接

链接

  • 站内链接使用相对路径，如 [提示词工程](../ai/prompting.md)
  • 站外链接直接给出完整 URL

图片

  • 图片存放在文章同级的 images/ 子目录
  • 文件命名：小写英文、下划线分隔，如 agent-flow.png
  • 图片应有 alt 文本

列表

  • 无序列表使用 -，有序列表使用 1.
  • 条目保持简洁，一行为一个知识点
发现错误？想一起完善？ 在 GitHub 上编辑此页！
本页面贡献者：AI-PM Wiki Team
本页面的全部内容在 CC BY-SA 4.0 和 SATA 协议之条款下提供，附加条款亦可能应用