Obsidian GitHub Publisher 安装和配置指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01252/article/details/143048586

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 仓库的工具。该项目的主要目的是简化笔记的发布流程，使得用户可以轻松地将 Obsidian 中的笔记同步到 GitHub 上，并进行进一步的管理和分享。

该项目主要使用 TypeScript 作为编程语言，同时也涉及到一些 CSS 和 JavaScript 代码。TypeScript 是一种强类型的 JavaScript 超集，广泛用于现代 Web 开发中，特别是在构建大型应用程序时。

2. 项目使用的关键技术和框架

Obsidian GitHub Publisher 项目中使用了一些关键的技术和框架，主要包括：

GitHub API：用于与 GitHub 仓库进行交互，包括创建分支、提交代码、合并分支等操作。
Obsidian API：Obsidian 插件开发的基础 API，用于与 Obsidian 应用程序进行交互，获取和修改笔记内容。
Markdown：项目主要处理 Markdown 格式的笔记，支持将 Obsidian 中的 [[wikilinks]] 转换为标准的 Markdown 链接。
TypeScript：作为主要的编程语言，提供了强类型支持和更好的开发体验。

3. 项目安装和配置的准备工作和详细安装步骤

准备工作

在开始安装和配置 Obsidian GitHub Publisher 之前，请确保你已经完成以下准备工作：

安装 Node.js：确保你的系统上已经安装了 Node.js。你可以通过访问 Node.js 官网下载并安装最新版本的 Node.js。
安装 Obsidian：确保你已经在本地安装了 Obsidian 应用程序，并且已经创建了一个 Obsidian Vault。
创建 GitHub 仓库：在 GitHub 上创建一个新的仓库，用于存储你的笔记。
生成 GitHub Token：在 GitHub 上生成一个个人访问令牌（Token），用于授权 Obsidian GitHub Publisher 访问你的 GitHub 仓库。

详细安装步骤

克隆项目仓库：打开终端或命令行工具，运行以下命令克隆 Obsidian GitHub Publisher 项目仓库到本地：
```
git clone https://github.com/ObsidianPublisher/obsidian-github-publisher.git
```
安装依赖：进入项目目录，运行以下命令安装项目所需的依赖：
```
cd obsidian-github-publisher
npm install
```
配置项目：在项目根目录下找到 config.json 文件，并根据你的需求进行配置。主要配置项包括：
- githubUsername：你的 GitHub 用户名。
- githubRepository：你创建的 GitHub 仓库名称。
- githubBranch：你希望发布笔记的分支名称（通常为 main 或 master）。
- githubToken：你在 GitHub 上生成的个人访问令牌。
示例配置：
```
{
  "githubUsername": "your-username",
  "githubRepository": "your-repo-name",
  "githubBranch": "main",
  "githubToken": "your-github-token"
}
```
启动项目：配置完成后，运行以下命令启动项目：
```
npm start
```
发布笔记：在 Obsidian 中打开你的 Vault，选择你希望发布的笔记，并在笔记的 Front Matter 中添加以下内容：
```
---
share: true
---
```
然后，在 Obsidian 的命令面板中运行 Upload single current active note 命令，即可将笔记发布到你的 GitHub 仓库中。
检查发布结果：打开你的 GitHub 仓库，检查笔记是否已经成功发布到指定的分支中。如果一切正常，你将看到新的提交记录和笔记文件。