写作规范与命名规范
写作规范与命名规范 本文档定义了博客文章的写作规范、文件命名规范，以及如何在博客中融合双链笔记（双向链接）功能。 📋 目录 文件命名规范 写作规范 双链笔记融合指南 Front Matter 规范 目录结构规范 最佳实践 📝 文件命名规范 基本原则 使用小写字母和连字符（kebab-case） ✅ 正确：hugo-blog-setup-guide.md ❌ 错误：Hugo_Blog_Setup_Guide.md、hugoBlogSetupGuide.md 使用有意义的描述性名称 ✅ 正确：obsidian-hugo-integration-tutorial.md ❌ 错误：post1.md、article.md、untitled.md 避免特殊字符 不允许：空格、中文标点、特殊符号（!@#$%^&*()） 允许：连字符 -、下划线 _（推荐使用连字符） 包含关键词 文件名应反映文章的核心主题 便于 SEO 和文件查找 命名模式 模式 1：主题-描述（推荐） 技术栈-具体主题.md 示例： hugo-automation-setup.md obsidian-daily-workflow.md github-actions-deployment.md 模式 2：日期-主题（可选） YYYY-MM-DD-主题描述.md 示例： 2025-01-20-writing-guidelines.md 2025-01-15-weekly-summary.md 注意： 如果使用日期前缀，确保在 Front Matter 中也设置正确的 date 字段。 模式 3：分类-主题 分类-主题描述.md 示例： tutorial-hugo-setup.md review-obsidian-plugins.md tutorial-git-workflow.md 命名检查清单 创建新文件前，确认： 文件名全小写 使用连字符分隔单词 文件名清晰描述内容 无空格和特殊字符 长度适中（建议 20-50 个字符） 避免重复（检查现有文件） ✍️ 写作规范 文章结构 每篇博客文章应包含以下部分： ...