将Obsidian笔记库转换为简约大气个人博客网站的工具。
- 🚀 自动扫描: 自动扫描Obsidian vault中的markdown文件
- 📝 元数据解析: 支持YAML frontmatter和自动元数据提取
- 🎨 响应式设计: 适配桌面、平板和移动设备
- 🔍 搜索功能: 内置全文搜索功能
- 🏗️ 静态生成: 生成纯静态HTML网站
- ⚡ 快速部署: 可部署到任何静态网站托管服务
项目提供了一键编译和部署脚本,支持指定JSON配置文件并可选择不同的部署方式。
Linux/macOS:
chmod +x deploy.sh
./deploy.sh [-c config_file] [-d deploy_method]Windows:
deploy.bat [-c config_file] [-d deploy_method]参数说明:
-c, --config: 指定JSON配置文件路径(默认:./blog.config.json)-d, --deploy: 指定部署方式(github,vercel,netlify,docker,local)
示例:
# 使用默认配置本地预览
./deploy.sh
# 使用自定义配置文件本地预览
./deploy.sh -c my-config.json
# 使用自定义配置文件部署到GitHub Pages
./deploy.sh -c my-config.json -d github
# 使用自定义配置文件部署到Vercel
./deploy.sh -c my-config.json -d vercel
# 使用自定义配置文件部署到Netlify
./deploy.sh -c my-config.json -d netlify
# 使用自定义配置文件部署到Docker
./deploy.sh -c my-config.json -d docker| 选项 | 类型 | 默认值 | 描述 |
|---|---|---|---|
vaultPath |
string | "./vault" |
Obsidian vault路径 |
outputPath |
string | "./dist" |
生成网站的输出路径 |
siteTitle |
string | "My Obsidian Blog" |
网站标题 |
siteDescription |
string | "A blog generated from Obsidian notes" |
网站描述 |
author |
string | "" |
作者名称 |
theme |
string | "auto" |
主题 (light/dark/auto) |
postsPerPage |
number | 10 |
每页显示的文章数量 |
配置文件是一个 JSON 文件,具有以下结构:
{
"vaultPath": "./vault",
"outputPath": "./dist",
"siteTitle": "我的 Obsidian 博客",
"siteDescription": "从 Obsidian 笔记生成的博客",
"author": "",
"theme": "auto",
"postsPerPage": 10
}MIT License