Obsidian GitHub Publisher 项目下载及安装教程

Obsidian GitHub Publisher 项目下载及安装教程

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

1. 项目介绍

Obsidian GitHub Publisher 是一个帮助用户从 Obsidian Vault 中免费发布笔记到 GitHub 仓库的插件。它允许用户将笔记转换为 Markdown 格式，并自动推送到指定的 GitHub 仓库中。该插件支持多种模板，如 Jekyll、Mkdocs、Hugo 等，并且可以处理各种 Markdown 语法和格式，如 Mermaid 和 Latex。

2. 项目下载位置

要下载 Obsidian GitHub Publisher 项目，请访问项目的 GitHub 仓库。你可以通过以下步骤进行下载：

1. 打开终端或命令行工具。

2. 使用 git clone 命令下载项目：

   git clone https://github.com/ObsidianPublisher/obsidian-github-publisher.git
   

   这将把项目克隆到你的本地机器上。

3. 项目安装环境配置

在安装 Obsidian GitHub Publisher 之前，你需要确保你的系统满足以下环境要求：

• Node.js：确保你已经安装了 Node.js 和 npm（Node.js 的包管理器）。你可以通过以下命令检查是否已安装：

  node -v
  npm -v
  

  如果未安装，请访问 Node.js 官方网站 下载并安装。

• Obsidian：确保你已经安装了 Obsidian 笔记应用。你可以从 Obsidian 官方网站 下载并安装。

环境配置示例

以下是配置环境的一个示例：

4. 项目安装方式

安装 Obsidian GitHub Publisher 的步骤如下：

1. 进入项目目录：

   cd obsidian-github-publisher
   

2. 安装项目依赖：

   npm install
   

3. 构建项目：

   npm run build
   

4. 将生成的插件文件夹复制到 Obsidian 的插件目录中。通常，这个目录位于 你的 Obsidian 数据目录/plugins/ 下。

5. 在 Obsidian 中启用插件：

   • 打开 Obsidian。
   • 进入设置（Settings）。
   • 选择“社区插件”（Community Plugins）。
   • 点击“浏览”（Browse）并找到 Obsidian GitHub Publisher 插件。
   • 点击“安装”（Install）并启用插件。

5. 项目处理脚本

Obsidian GitHub Publisher 提供了多个处理脚本，用于自动化笔记的发布和管理。以下是一些常用的脚本：

• 上传单个笔记：

  npm run upload:single
  

• 上传所有笔记：

  npm run upload:all
  

• 刷新已发布的笔记并上传新笔记：

  npm run refresh:published
  

• 清除已删除和未发布的笔记：

  npm run purge:deleted
  

通过这些脚本，你可以轻松管理你的笔记发布流程。

---

以上是 Obsidian GitHub Publisher 项目的下载及安装教程。希望这些步骤能帮助你顺利安装并使用该插件。

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