文章系统使用指南
这个文件夹用于存放网站的文章内容,使用 Markdown 格式编写。
如何添加新文章
1. 创建 Markdown 文件
在 content/articles/ 目录下创建一个新的 .md 文件,文件名将作为文章的 URL slug。
例如:my-new-article.md 将生成 URL:/articles/my-new-article
2. 添加 Frontmatter
每篇文章必须包含 frontmatter(文件开头的元数据),格式如下:
---
title: "文章标题"
description: "文章简短描述"
date: "2024-12-18"
author: "作者姓名"
category: "分类名称"
tags: ["标签1", "标签2", "标签3"]
image: "/path/to/image.svg"
---
Frontmatter 字段说明:
- title (必填): 文章标题
- description (必填): 文章简短描述,显示在列表页
- date (必填): 发布日期,格式:YYYY-MM-DD
- author (可选): 作者姓名
- category (可选): 文章分类
- tags (可选): 文章标签数组
- image (可选): 文章封面图片路径
3. 编写文章内容
在 frontmatter 之后,使用标准 Markdown 语法编写文章内容:
# 一级标题
这是正文内容...
## 二级标题
### 三级标题
- 列表项 1
- 列表项 2
**粗体文字**
*斜体文字*
[链接文字](https://example.com)
4. 支持的 Markdown 功能
- 标题 (H1-H6)
- 段落和换行
- 粗体 和 斜体
- 列表(有序和无序)
- 链接
- 图片
- 引用块
- 代码块
- 表格
- 水平分隔线
完整示例
---
title: "我的第一篇文章"
description: "这是一篇示例文章,展示如何使用 Markdown 编写内容"
date: "2024-12-18"
author: "张三"
category: "教程"
tags: ["Markdown", "写作", "指南"]
image: "/personality-types/avatars/intj-architect.svg"
---
# 我的第一篇文章
这是文章的开头段落。
## 第一部分
这里是第一部分的内容...
### 小节标题
- 要点一
- 要点二
- 要点三
## 第二部分
更多内容...
文章管理
查看文章列表
访问:/articles
查看单篇文章
访问:/articles/文件名 (不含 .md 扩展名)
文章排序
文章在列表页按日期降序排列(最新的在前)。
注意事项
-
文件命名:使用小写字母、数字和连字符,避免空格和特殊字符
- 好的命名:
my-article.md,guide-2024.md - 不好的命名:
My Article.md,文章123.md
- 好的命名:
-
日期格式:严格使用
YYYY-MM-DD格式 -
图片路径:图片应放在
public/目录下,路径以/开头 -
编译:添加或修改文章后,需要重新编译项目:
npm run build -
预览:在开发模式下可以实时预览:
npm run dev
工作流程
- 在
content/articles/创建新的.md文件 - 编写 frontmatter 和文章内容
- 保存文件
- 运行
npm run dev预览 - 满意后运行
npm run build编译 - 部署更新后的网站
需要帮助?
如果遇到问题,请检查:
- Frontmatter 格式是否正确
- 日期格式是否为 YYYY-MM-DD
- 文件扩展名是否为 .md
- 是否重新编译了项目