order: 1

✉️ Enveloppe：Obsidian GitHub 知识库发布工具

免费将您的笔记发布到您自己的 GitHub 仓库中，随心所欲地处理它们。✨

这允许您设置任何模板：Jekyll、Mkdocs、Hugo 或自定义模板！

📑 文档

这里只提供快速设置指南！

🪄 功能

• 将 [[wikilinks]] 转换为 markdown 链接
• 链接到其他笔记并根据您的设置更新链接
• 通过删除已取消发布和已删除的文件来清理仓库
• 文件夹笔记（将它们重命名为特定名称，如 index.md）
• 支持所有 dataview 查询（包括 dataviewjs、内联 DQL 和内联 dataviewJS）
• 支持您模板支持的任何 markdown 语法，以及其他格式如 Mermaid 或 Latex
• 还有更多功能 :sparkles:

[!警告] 请勿使用此插件来同步或保存您的 Obsidian 知识库！ 避免在 Obsidian 中打开仓库中的转换后文件！

🖥️ 初始设置

有许多可用选项，其中一些是预配置的，而其他则是可选的。

在开始之前，您需要配置 GitHub 仓库。

1. 填写您的用户名、仓库名和分支。
2. 从设置链接生成 GitHub 令牌并粘贴到此处。
3. 点击按钮检查一切是否正常运行。
4. 现在，让我们尝试发布您的第一个笔记！为此，您需要在文件的前置元数据中设置 share: true 键，如下所示：

   ---
   share: true
   ---
   

5. 现在，运行发布命令：上传当前活动笔记
6. 如果一切顺利，将在您的仓库中创建一个 PR 并自动合并（如果需要，可以禁用此功能！）。

就是这样！然而，还有许多选项是一个简单的 README 无法涵盖的，所以请参阅文档以获取更多信息。💕

⚙️ 使用方法

该插件在命令面板中添加了 8 个命令，其中一个也可在右键菜单中使用。

• 上传当前活动笔记（可在右键菜单中使用）
• 上传所有笔记
• 上传未发布的笔记
• 刷新已发布并上传新笔记
• 刷新所有已发布笔记
• 清理已取消发布和已删除的文件
• 测试与配置仓库的连接
• 检查 GitHub API 的请求限制

每个命令的解释可在此处找到。

🤖 工作原理

1. 插件将创建一个以您的知识库命名的分支，其中空格将被 - 替换。
2. 插件将执行所有转换（基于您的设置）并将笔记推送到该分支。
3. 默认情况下，一旦所有笔记（及其嵌入文件）处理完毕，该分支将被合并。

[!警告] 有时，由于合并冲突，分支可能无法合并。这可能是由于推送过于频繁造成的。

🪛 开发

您可以：

• 维护项目并添加新功能
• 帮助翻译

🪧 寻找什么？

→ 设置说明 ← 命令参考 → GitHub 讨论

如果您觉得这个插件和工作流程有用，可以给我买杯咖啡！