Enveloppe：基于Obsidian的GitHub知识库发布插件

💌 Enveloppe：基于Obsidian的GitHub知识库发布插件

obsidian-github-publisher Github Publisher helps you to publish your notes on a preconfigured GitHub repository from your Obsidian Vault, for free, and more! 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-github-publisher

Enveloppe 是一个强大的工具，允许您将Obsidian笔记免费发布到您的GitHub仓库，并随心所欲地进行自定义处理。通过这个插件，您可以利用Jekyll、Mkdocs、Hugo等模板或者设计自己的模板，将您的私人知识转化为公开的在线资源。

📦 安装指南

步骤一：安装插件

在Obsidian社区插件库中搜索“Enveloppe”，或通过BRAT（如果可用）添加此插件。确认安装并重启Obsidian以使插件生效。

步骤二：配置GitHub仓库

1. 访问您的GitHub账户，创建一个新的仓库或选择现有的用于发布笔记。
2. 在仓库设置中生成一个个人访问令牌（PAT），确保该令牌拥有仓库必要的操作权限。

步骤三：设置插件

• 打开Obsidian，进入插件设置。
• 输入您的GitHub用户名、仓库名、分支名。
• 粘贴刚才生成的PAT。
• 测试连接，确保信息正确无误。

步骤四：前端事项配置

对于需要发布的笔记，在其前言部分加入：

---
share: true
---

这将会标记此文件待上传。

使用说明

基本操作

• 发布单个当前活动笔记：右键菜单或命令调色板均有此选项。
• 上传所有笔记：一次性处理全部笔记。
• 管理已发布与未发布：有多个命令来刷新、新增或清理已发布的内容。

详细命令功能和使用场景可在官方文档的命令章节查看。

注意事项

避免直接用Obsidian打开仓库中的转换文件，以防同步冲突。发布过程自动处理wikilink、支持Dataview查询与多种Markdown增强语法。

API使用文档

Enveloppe内部使用GitHub API来进行仓库交互，用户无需直接操作API。但开发者若想深入了解或扩展插件功能，可参考GitHub REST API文档，特别是在自动化仓库管理和文件操作方面。

插件安装方式回顾

安装方式已在“安装指南”中详述，通过Obsidian的社区插件系统完成，确保配合正确的GitHub仓库配置。

---

通过上述步骤，您可以轻松集成Enveloppe到您的知识管理工作流程中，享受从私密笔记到在线知识库的无缝转换体验。记住，深入探索项目文档将为您提供更全面的定制能力和解决具体问题的方法。动手试试吧，释放您的知识分享潜力！

obsidian-github-publisher Github Publisher helps you to publish your notes on a preconfigured GitHub repository from your Obsidian Vault, for free, and more! 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-github-publisher