85 lines
2.1 KiB
Markdown
85 lines
2.1 KiB
Markdown
# VitePress Exporter - Obsidian Plugin
|
||
|
||
## 功能
|
||
|
||
这个 Obsidian 插件用于自动化发布 Obsidian 笔记到 VitePress 网站：
|
||
|
||
- ✅ 将当前 markdown 文件导出到 `docs/` 目录
|
||
- ✅ 自动复制引用的资源文件到 `docs/assets/` 目录
|
||
- ✅ 更新 markdown 中的资源路径
|
||
- 🚧 Canvas 文件渲染（待实现）
|
||
|
||
## 安装
|
||
|
||
插件已经安装在这个项目的 `.obsidian/plugins/vitepress-exporter/` 目录下。
|
||
|
||
1. 在 Obsidian 中打开这个项目
|
||
2. 进入设置 → 第三方插件
|
||
3. 启用 "VitePress Exporter" 插件
|
||
|
||
## 使用
|
||
|
||
### 方式 1：命令面板
|
||
1. 打开一个 markdown 文件
|
||
2. 按 `Ctrl+P` (或 `Cmd+P`) 打开命令面板
|
||
3. 输入 "Export to VitePress"
|
||
4. 选择 "Export current note to VitePress"
|
||
|
||
### 方式 2：功能区按钮
|
||
- 点击左侧功能区栏的上传图标按钮
|
||
|
||
### 方式 3：快捷键
|
||
- 可以在 Obsidian 的快捷键设置中为导出命令设置快捷键
|
||
|
||
## 配置
|
||
|
||
在插件设置中可以配置：
|
||
|
||
- **Docs path**: 导出的 markdown 文件存放目录（默认：`docs`）
|
||
- **Assets path**: 资源文件存放目录（默认：`docs/assets`）
|
||
|
||
## 工作流程
|
||
|
||
1. 用户在 Obsidian 中编写笔记
|
||
2. 笔记中引用的资源（图片、PDF 等）可以放在任意位置
|
||
3. 点击导出按钮
|
||
4. 插件自动：
|
||
- 将 markdown 文件复制到 `docs/` 目录
|
||
- 扫描并复制所有引用的资源到 `docs/assets/` 目录
|
||
- 更新 markdown 中的资源路径
|
||
|
||
## 当前状态
|
||
|
||
- ✅ 基础插件框架
|
||
- ✅ 文件导出功能
|
||
- ✅ 资源文件自动复制
|
||
- 🚧 Canvas 文件渲染（开发中）
|
||
|
||
## Canvas 渲染计划
|
||
|
||
对于 `.canvas` 文件，计划实现的方案：
|
||
|
||
1. **方案 A（优先）**：基于 Obsidian 自己的渲染（探索中）
|
||
2. **方案 B（备选）**：使用 Headless Browser 手动渲染 JSON Canvas
|
||
|
||
## 开发
|
||
|
||
```bash
|
||
cd .obsidian/plugins/vitepress-exporter
|
||
|
||
# 安装依赖
|
||
npm install
|
||
|
||
# 开发模式（自动重新编译）
|
||
npm run dev
|
||
|
||
# 生产构建
|
||
npm run build
|
||
```
|
||
|
||
## 注意事项
|
||
|
||
- 确保项目中有 `docs/` 目录
|
||
- 资源文件会被复制，不会移动原文件
|
||
- 如果目标文件已存在，会被覆盖
|