躺平小站 - 快速使用指南
本文档将帮助你快速掌握博客的基本使用方法,包括发文、写日记、添加相册等核心功能。
📝 一、如何发布文章
1. 文章存放位置
所有文章都存放在 src/content/posts/ 目录下,每篇文章是一个独立的 .md 文件。
2. 文章格式
每篇文章的开头必须包含 frontmatter(元数据),格式如下:
---title: 文章标题published: 2025-02-25description: 文章简介,会显示在文章列表中tags: [标签1, 标签2, 标签3]category: 分类名称draft: falsepinned: false---
这里是文章正文内容,使用 Markdown 语法编写。3. frontmatter 字段说明
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
title | string | 是 | 文章标题 |
published | date | 是 | 发布日期,格式:YYYY-MM-DD |
description | string | 是 | 文章简介 |
tags | array | 是 | 标签数组,如:["技术", "教程"] |
category | string | 是 | 分类名称,如:"技术" |
draft | boolean | 否 | 是否为草稿(true 不显示,false 显示) |
pinned | boolean | 否 | 是否置顶(true 置顶,false 不置顶) |
encrypted | boolean | 否 | 是否加密(true 加密,false 不加密) |
password | string | 否 | 加密密码(encrypted为true时必需) |
alias | string | 否 | 文章别名,自定义URL路径 |
image | string | 否 | 文章封面图片路径 |
author | string | 否 | 文章作者 |
sourceLink | string | 否 | 文章源链接或参考 |
licenseName | string | 否 | 文章内容的许可证名称 |
4. 示例文章
在 src/content/posts/ 目录下创建 hello-world.md:
---title: 我的第一篇文章published: 2025-02-25description: 欢迎来到我的博客tags: [生活, 随笔]category: 生活draft: falsepinned: false---
# 欢迎来到我的博客
这是我的第一篇文章,使用 Markdown 语法编写。
## 二级标题
- 列表项 1- 列表项 2
**粗体** 和 *斜体* 文本。5. 注意事项
- 文件名建议使用英文,如:
hello-world.md - 文章会自动按发布日期排序,最新的在前
- 设置
draft: true的文章不会显示在网站上 - 设置
pinned: true的文章会固定在列表顶部
📒 二、如何写日记
1. 日记存放位置
日记数据存放在 src/data/diary.ts 文件中。
2. 日记格式
在 diaryData 数组中添加新的日记对象:
{ id: 1, // 日记编号(唯一,递增) content: "今天天气真好!", // 日记内容 date: "2025-02-25T14:30:00Z", // 发布时间(ISO格式) images: ["/images/diary/1.jpg"], // 可选:图片数组 location: "北京", // 可选:地点 mood: "开心", // 可选:心情 tags: ["日常", "生活"] // 可选:标签}3. 添加日记示例
打开 src/data/diary.ts,在 diaryData 数组中添加:
const diaryData: DiaryItem[] = [ { id: 1, content: "今天天气真好,出去散步了!", date: "2025-02-25T14:30:00Z", images: ["/images/diary/sakura.jpg"], location: "公园", mood: "开心", tags: ["日常", "生活"], }, { id: 2, content: "学习了一整天,收获满满!", date: "2025-02-25T20:00:00Z", mood: "充实", tags: ["学习"], },];4. 添加日记图片
- 将图片放入
public/images/diary/目录 - 在日记的
images字段中引用图片路径
5. 注意事项
id必须唯一,建议递增date使用 ISO 格式:YYYY-MM-DDTHH:mm:ssZ- 日记会自动按时间倒序显示(最新的在前)
- 只显示最近 30 条日记
📷 三、如何新增相册
相册支持两种模式:本地模式(推荐)和外链模式。
方式一:本地模式(推荐)
1. 创建相册文件夹
在 public/images/albums/ 目录下创建一个新文件夹,例如 my-album:
public/images/albums/└── my-album/ ├── cover.jpg # 相册封面图(必需) ├── info.json # 相册信息文件(必需) ├── photo1.jpg # 照片文件 ├── photo2.jpg └── photo3.jpg2. 创建 info.json
在相册文件夹中创建 info.json 文件:
{ "title": "我的相册", "description": "这是我的第一个相册", "date": "2025-02-25", "location": "北京", "tags": ["生活", "旅行"], "layout": "grid", "columns": 3, "hidden": false}3. 添加照片
将照片文件(jpg、png、gif、webp等)直接放入相册文件夹即可。
4. 照片标签(可选)
照片文件名支持标签格式:文件名_标签1_标签2.jpg
例如:
sunset_风景_傍晚.jpg- 会被识别为标签:[“风景”, “傍晚”]
方式二:外链模式
1. 创建相册文件夹
在 public/images/albums/ 目录下创建文件夹:
public/images/albums/└── my-album/ └── info.json2. 创建 info.json
{ "mode": "external", "title": "我的相册", "description": "这是外链相册", "date": "2025-02-25", "location": "北京", "tags": ["生活", "旅行"], "cover": "https://example.com/cover.jpg", "photos": [ { "src": "https://example.com/photo1.jpg", "thumbnail": "https://example.com/thumb1.jpg", "title": "照片标题", "description": "照片描述", "tags": ["风景"], "date": "2025-02-25", "width": 1920, "height": 1080 } ]}info.json 字段说明
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
mode | string | 否 | local(默认)或 external |
title | string | 是 | 相册标题 |
description | string | 否 | 相册描述 |
date | string | 否 | 相册日期(YYYY-MM-DD) |
location | string | 否 | 拍摄地点 |
tags | array | 否 | 相册标签数组 |
layout | string | 否 | 布局:grid(默认)或 masonry |
columns | number | 否 | 列数(默认3) |
hidden | boolean | 否 | 是否隐藏相册(默认false) |
cover | string | 外链模式必需 | 封面图URL |
photos | array | 外链模式必需 | 照片数组 |
注意事项
- 本地模式:必须包含
cover.jpg文件 - 外链模式:不需要本地图片文件,所有图片URL在
info.json中配置 - 支持的图片格式:jpg、jpeg、png、gif、webp、svg、avif、bmp、tiff
- 相册会自动扫描,添加后刷新页面即可看到
🎨 四、常用配置
修改网站信息
打开 src/config.ts 文件,找到 siteConfig:
export const siteConfig: SiteConfig = { title: "躺平小站", // 网站标题 subtitle: "一个简单的个人博客", // 网站副标题 siteURL: "https://bk.ltai.top/", // 网站地址 // ...};修改导航栏
在 src/config.ts 中找到 navBarConfig:
export const navBarConfig: NavBarConfig = { links: [ LinkPreset.Home, // 主页 LinkPreset.Archive, // 归档 // 添加自定义链接... ],};修改个人资料
在 src/config.ts 中找到 profileConfig:
export const profileConfig: ProfileConfig = { avatar: "assets/images/avatar.webp", // 头像路径 name: "躺平小站", // 昵称 bio: "记录生活,分享美好", // 简介 // ...};🚀 五、启动和预览
1. 安装依赖
pnpm install2. 启动开发服务器
pnpm dev3. 访问网站
打开浏览器访问:http://localhost:4321/
4. 修改后自动刷新
修改任何文件后,浏览器会自动刷新显示最新内容。
📒 六、Markdown 语法指南
本博客支持完整的 Markdown 语法,包括基础语法和扩展功能。
1. 基础语法
标题
# 一级标题## 二级标题### 三级标题段落和换行
这是一个段落。
这是另一个段落。
行尾添加两个空格可以<br>强制换行。强调
**粗体文本***斜体文本****粗斜体文本***~~删除线文本~~列表
无序列表:
- 项目 1- 项目 2 - 子项目 2.1 - 子项目 2.2有序列表:
1. 第一项2. 第二项3. 第三项引用
> 这是一个引用块>> > 嵌套引用代码
行内代码:
使用 `code()` 函数代码块:
```javascriptfunction hello() { console.log("Hello, World!");}```链接和图片
[链接文本](https://example.com)
表格
| 列1 | 列2 | 列3 ||-----|-----|-----|| 数据1 | 数据2 | 数据3 || 数据4 | 数据5 | 数据6 |2. 扩展功能
提示框
支持以下类型的提示框:note、tip、important、warning、caution
:::note突出显示用户在浏览时应该考虑的信息。:::
:::tip帮助用户更成功的可选信息。:::
:::important用户成功所需的关键信息。:::
:::warning由于潜在风险需要用户立即关注的关键内容。:::
:::caution操作的负面潜在后果。:::自定义标题:
:::note[我的自定义标题]这是一个带有自定义标题的提示框。:::GitHub 语法:
> [!NOTE]GitHub语法也被支持。
> [!TIP]GitHub语法也被支持。剧透
可以在文本中添加剧透,文本也支持 Markdown 语法:
内容 :spoiler[被隐藏了 **嘿嘿**]!GitHub 仓库卡片
可以添加动态卡片来链接到 GitHub 仓库:
::github{repo="matsuzaka-yuki/Mizuki"}3. Mermaid 图表
本博客支持 Mermaid 图表,可以在文章中创建各种类型的图表。
流程图
序列图
甘特图
类图
状态图
饼图
4. 嵌入视频
可以在文章中嵌入来自 YouTube、Bilibili 等平台的视频。
YouTube 视频
<iframe width="100%" height="468" src="https://www.youtube.com/embed/视频ID" title="YouTube video player" frameborder="0" allowfullscreen></iframe>Bilibili 视频
<iframe width="100%" height="468" src="//player.bilibili.com/player.html?bvid=视频ID&p=1&autoplay=0" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true"></iframe>5. 内联 HTML
对于任何未被 Markdown 语法覆盖的标记,可以直接使用 HTML:
<div class="custom-box"> <h3>自定义标题</h3> <p>这是自定义的 HTML 内容。</p></div>6. 自动链接
Markdown 支持为 URL 和电子邮件地址创建自动链接:
<https://example.com/><address@example.com>💡 七、进阶技巧
1. 文章加密
在文章 frontmatter 中添加:
---encrypted: truepassword: "123456"---2. 文章置顶
在文章 frontmatter 中添加:
---pinned: true---3. 文章别名
在文章 frontmatter 中添加:
---alias: "custom-url"---访问地址变为:/posts/custom-url/
❓ 八、常见问题
Q1: 文章发布后不显示?
- 检查
draft字段是否设置为false - 检查文件是否在
src/content/posts/目录下 - 尝试刷新浏览器
Q2: 日记不显示?
- 检查
id是否唯一 - 检查
date格式是否正确(ISO格式) - 确认日记在
diaryData数组中
Q3: 相册不显示?
- 检查
info.json格式是否正确 - 本地模式:检查是否有
cover.jpg - 外链模式:检查
mode是否设置为external - 检查
hidden是否为false
Q4: 图片不显示?
- 确认图片在
public目录下 - 检查图片路径是否正确
- 确认图片格式是否支持
Q5: Mermaid 图表不显示?
- 确保使用正确的语法:```mermaid
- 检查图表代码是否完整
- 某些复杂图表可能需要等待加载
Q6: 加密文章无法打开?
- 确认
encrypted设置为true - 确认
password字段已设置 - 检查密码是否正确
📖 九、更多帮助
- 完整文档:https://docs.mizuki.mysqil.com/
- Astro 文档:https://docs.astro.build/
- GitHub 仓库:https://github.com/matsuzaka-yuki/Mizuki
祝你使用愉快!🎉
部分信息可能已经过时









