2309 words
12 minutes
Readme
🌸 Mizuki
![Mizuki Preview]
一个现代化、功能丰富的静态博客模板,基于 Astro 构建,具有先进的功能和精美的设计。
🆕 v5.0 版本更新
- Pio 看板娘集成:集成了 Pio 看板娘,提供可爱的互动角色,增强用户互动体验。
- 高度可配置:支持在
src/config.ts中进行详细配置,包括模型路径、位置、尺寸、对话内容等,满足个性化需求。 - 无刷新跳转:看板娘的返回首页功能现在使用主题自带的 Swup 无刷新跳转,提供更流畅、无缝的页面切换体验。
🆕 v4.6 版本更新
- 番剧页面: 重构了更可爱好看的番剧页面,包括番剧列表、番剧详情和番剧时间轴。
- 相册页面: 重构了相册页面,使用分页+文件夹数据索引方案
- 全新的动画: 使用了全新的动画组件,使页面更加流畅和美观
- 图片API的支持 支持图片API,可以快速获取图片信息,使用(PicFlow API项目)[https://github.com/matsuzaka-yuki/PicFlow-API]
🆕 v3.4 版本更新
- 新增页面: 添加了项目展示、技能展示和时间线专属页面,用于展示您的工作、专业技能和成长历程。
- 下拉菜单修复: 解决了下拉菜单点击时出现边框轮廓的问题,提升了界面一致性。
- 搜索功能优化: 增强了搜索功能的性能和准确性。
- 底部HTML注入: 引入了新功能,允许在页面底部注入自定义HTML内容,提供更大的灵活性。
🆕 v3.3 版本更新
- Mermaid 语法支持: 添加了对 Mermaid 图表语法的支持,现在可以在 Markdown 中直接嵌入流程图、序列图、甘特图等。
- Umami 访问统计: 添加了对 Umami 访问统计的支持,可以轻松集成网站访问数据分析。
![Configuration]
🔧 组件配置系统重构
- 统一配置架构: 全新的模块化组件配置体系,支持动态组件管理和顺序配置
- 配置驱动的组件加载: 重构 SideBar 组件,实现完全基于配置的组件加载机制
- 统一控制开关: 移除音乐播放器和公告组件的独立 enable 开关,统一由 sidebarLayoutConfig 控制
- 响应式布局适配: 组件支持响应式布局,可根据设备类型自动调整显示
📐 布局系统优化
- 侧边栏位置动态调整: 支持左右侧边栏切换,布局自动适配
- 文章目录智能定位: 当侧边栏在右侧时,文章导航自动移至左侧,提供更好的阅读体验
- 网格布局改进: 优化 CSS Grid 布局,解决容器宽度异常问题
🎛️ 配置文件格式规范
- 标准化配置格式: 创建统一的组件配置文件格式规范
- 类型安全: 完善的 TypeScript 类型定义,确保配置的类型安全
- 可扩展性: 支持自定义组件类型和配置选项
🧹 代码优化
- 测试文件清理: 移除未使用的测试配置和依赖,减少项目体积
- 代码结构优化: 改进组件架构,提升代码可维护性
- 性能提升: 优化组件加载逻辑,提升页面渲染性能
✨ 功能特性
🎨 设计与界面
- 基于 Astro 和 Tailwind CSS 构建
- 使用 Swup 实现流畅的动画和页面过渡
- 明暗主题切换,支持系统偏好检测
- 可自定义主题色彩和动态横幅轮播
- 全屏背景图片,支持轮播、透明度和模糊效果
- 全设备响应式设计
- 使用 JetBrains Mono 字体的优美排版
🔍 内容与搜索
- 基于 Pagefind 的高级搜索功能
- 增强的 Markdown 功能,支持语法高亮
- 交互式目录,支持自动滚动
- RSS 订阅生成
- 阅读时间估算
- 文章分类和标签系统
📱 特色页面
- 追番页面 - 追踪动画观看进度和评分
- 友链页面 - 精美卡片展示朋友网站
- 日记页面 - 分享生活瞬间,类似社交媒体
- 归档页面 - 有序的文章时间线视图
- 关于页面 - 可自定义的个人介绍
🛠 技术特性
- 增强代码块,基于 Expressive Code
- 数学公式支持,KaTeX 渲染
- 图片优化,PhotoSwipe 画廊集成
- SEO 优化,包含站点地图和元标签
- 性能优化,懒加载和缓存机制
- 评论系统,支持 Twikoo 集成
🚀 快速开始
📦 安装
-
克隆仓库:
Terminal window git clone https://github.com/matsuzaka-yuki/mizuki.gitcd mizuki -
安装依赖:
Terminal window # 如果没有安装 pnpm,先安装npm install -g pnpm# 安装项目依赖pnpm install -
配置博客:
- 编辑
src/config.ts自定义博客设置 - 更新站点信息、主题色彩、横幅图片和社交链接
- 配置特色页面功能
- 编辑
-
启动开发服务器:
Terminal window pnpm dev博客将在
http://localhost:4321可用
📝 内容管理
- 创建新文章:
pnpm new-post <文件名> - 编辑文章: 修改
src/content/posts/中的文件 - 自定义页面: 编辑
src/content/spec/中的特殊页面 - 添加图片: 将图片放在
src/assets/或public/中
🚀 部署
将博客部署到任何静态托管平台:
- Vercel: 连接 GitHub 仓库到 Vercel
- Netlify: 直接从 GitHub 部署
- GitHub Pages: 使用包含的 GitHub Actions 工作流
- Cloudflare Pages: 连接您的仓库
部署前,请在 astro.config.mjs 中更新 site URL。
📝 文章前言格式
---title: 我的第一篇博客文章published: 2023-09-09description: 这是我新博客的第一篇文章。image: ./cover.jpgtags: [标签1, 标签2]category: 前端draft: falsepinned: falselang: zh-CN # 仅当文章语言与 config.ts 中的站点语言不同时设置---Frontmatter 字段说明
- title: 文章标题(必需)
- published: 发布日期(必需)
- description: 文章描述,用于 SEO 和预览
- image: 封面图片路径(相对于文章文件)
- tags: 标签数组,用于分类
- category: 文章分类
- draft: 设置为
true在生产环境中隐藏文章 - pinned: 设置为
true将文章置顶 - lang: 文章语言(仅当与站点默认语言不同时设置)
置顶文章功能
pinned 字段允许您将重要文章置顶到博客列表的顶部。置顶文章将始终显示在普通文章之前,无论其发布日期如何。
使用方法:
pinned: true # 将此文章置顶pinned: false # 普通文章(默认)排序规则:
- 置顶文章优先显示,按发布日期排序(最新在前)
- 普通文章随后显示,按发布日期排序(最新在前)
🧩 Markdown 扩展语法
Mizuki 支持超越标准 GitHub Flavored Markdown 的增强功能:
📝 增强写作
- 提示框: 使用
> [!NOTE]、> [!TIP]、> [!WARNING]等创建精美的标注框 - 数学公式: 使用
$行内$和$$块级$$语法编写 LaTeX 数学公式 - 代码高亮: 高级语法高亮,支持行号和复制按钮
- GitHub 卡片: 使用
::github{repo="用户/仓库"}嵌入仓库卡片
🎨 视觉元素
- 图片画廊: 自动 PhotoSwipe 集成,支持图片查看
- 可折叠部分: 创建可展开的内容块
- 自定义组件: 使用特殊指令增强内容
📊 内容组织
- 目录: 从标题自动生成,支持平滑滚动
- 阅读时间: 自动计算和显示
- 文章元数据: 丰富的前言支持,包含分类和标签
⚡ 命令
所有命令都在项目根目录运行:
| 命令 | 操作 |
|---|---|
pnpm install | 安装依赖 |
pnpm dev | 在 localhost:4321 启动本地开发服务器 |
pnpm build | 构建生产站点到 ./dist/ |
pnpm preview | 在部署前本地预览构建 |
pnpm check | 运行 Astro 错误检查 |
pnpm format | 使用 Biome 格式化代码 |
pnpm lint | 检查并修复代码问题 |
pnpm new-post <文件名> | 创建新博客文章 |
pnpm astro ... | 运行 Astro CLI 命令 |
🎯 配置指南
🔧 基础配置
编辑 src/config.ts 自定义您的博客:
export const siteConfig: SiteConfig = { title: "您的博客名称", subtitle: "您的博客描述", lang: "zh-CN", // 或 "en"、"ja" 等 themeColor: { hue: 210, // 0-360,主题色调 fixed: false, // 隐藏主题色选择器 }, banner: { enable: true, src: ["assets/banner/1.webp"], // 横幅图片 carousel: { enable: true, interval: 0.8, // 秒 }, },};📱 特色页面配置
- 追番页面: 在
src/pages/anime.astro中编辑动画列表 - 友链页面: 在
src/content/spec/friends.md中编辑朋友数据 - 日记页面: 在
src/pages/diary.astro中编辑动态 - 关于页面: 在
src/content/spec/about.md中编辑内容
✏️ 贡献
我们欢迎贡献!请随时提交问题和拉取请求。
- Fork 仓库
- 创建功能分支 (
git checkout -b feature/amazing-feature) - 提交更改 (
git commit -m 'Add some amazing feature') - 推送到分支 (
git push origin feature/amazing-feature) - 打开拉取请求
📄 许可证
本项目基于 MIT 许可证 - 查看 LICENSE 文件了解详情。
🙏 致谢
- 基于原始 Fuwari 模板
- 使用 Astro 和 Tailwind CSS 构建
- 灵感来源于 Yukina - 一个美丽优雅的博客模板
- 图标来自 Iconify
特别感谢
- Yukina - 感谢提供设计灵感和创意,帮助塑造了这个项目。Yukina 是一个优雅的博客模板,展现了出色的设计原则和用户体验。
⭐ 如果您觉得这个项目有帮助,请考虑给它一个星标!
Some information may be outdated