Markdown 编写规范
1. 文件规范 1.1 文件扩展名 Markdown 文件必须使用 .md 扩展名。 正确: docker-installation.md docker-compose.md mysql-index.md 错误: docker-installation.markdown docker-installation.txt 1.2 文件名 文件名统一使用小写字母。 多个单词之间使用 - 分隔,不使用空格、下划线或驼峰命名。 推荐: docker-installation.md docker-image-optimization.md mysql-deep-pagination.md 不推荐: DockerInstallation.md docker_installation.md docker installation.md 1.3 文件编码 Markdown 文件必须使用 UTF-8 编码。 2. 标题规范 2.1 文档标题 按照 FEX 规范,文档标题可以使用 Setext 风格: Markdown 编写规范 ================ 如果项目使用 Hugo 等现代 Markdown 工具链,也可以使用: # Markdown 编写规范 但是,如果严格遵循 FEX Team 原规范,则推荐使用 Setext 风格作为文档标题。 对于 Hugo 技术文章,如果 Front Matter 已经提供 title,正文通常不再重复一级标题。 例如:...