mirror of
https://github.com/jxpeng98/obsidian-to-NotionNext
synced 2026-07-29 08:08:34 +08:00
docs: add documentation for Obsidian to NotionNext plugin setup and usage
This commit is contained in:
Jiaxin Peng
45
docs/zh/01-getting-started.md
Normal file
45
docs/zh/01-getting-started.md
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: 开始使用
|
||||
description: Obsidian to NotionNext 插件设置指南
|
||||
---
|
||||
|
||||
# 开始使用
|
||||
|
||||
## 获取 Notion API 令牌
|
||||
|
||||
在使用本插件前，你需要从 Notion 获取一个 API 令牌（Token），以授权插件访问你的 Notion 账户。
|
||||
|
||||
1. 前往 [Notion API](https://www.notion.so/profile/integrations) 页面来创建一个新的集成（integration）。你需要先登录你的 Notion 账户。
|
||||
2. 点击 `+ New integration`。
|
||||
|
||||
3. 填写一些基本信息：
|
||||
|
||||
4. 成功创建集成。
|
||||
|
||||
5. 进入“配置集成设置”页面，**准备好复制 API 令牌**，你很快就会在插件设置中用到它。
|
||||
|
||||
|
||||
::: warning
|
||||
**⚠️ 注意：** 请妥善保管你的 API 令牌，不要与他人分享，因为它授予了访问你 Notion 数据的权限。
|
||||
:::
|
||||
|
||||
## 创建 Notion 数据库并连接集成
|
||||
|
||||
接下来，你需要创建一个 Notion 数据库，用于存放从 Obsidian 同步过来的笔记。
|
||||
|
||||
1. 在你的 Notion 工作区中，点击 `Create a new page` 来创建一个新页面。
|
||||
|
||||
|
||||
2. 创建一个新页面后，选择 `Database - Full page` 选项。
|
||||
|
||||
|
||||
3. 点击数据库页面右上角的 `...` 菜单，进入 `Connections`，然后连接你刚刚创建的集成。
|
||||
|
||||
|
||||
4. 点击 `Share` -> `Publish`，将数据库发布到网络。
|
||||
|
||||
|
||||
5. 点击并复制 **数据库 ID**。
|
||||
|
||||
|
||||
接下来，你可以根据[安装指南](./02-installation.md)在 Obsidian 中安装和配置插件了。
|
||||
28
docs/zh/02-installation.md
Normal file
28
docs/zh/02-installation.md
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: 安装插件
|
||||
description: 如何安装 Obsidian to NotionNext 插件
|
||||
---
|
||||
|
||||
# 安装插件
|
||||
|
||||
当你在 Notion 端完成上一章节的设置后，就可以在 Obsidian 里安装和配置插件了。
|
||||
|
||||
1. 打开 Obsidian 的 `设置`。
|
||||
|
||||
|
||||
2. 找到 `第三方插件` 菜单。
|
||||
|
||||
::: tip
|
||||
如果你之前没有启用过第三方插件，可能需要先关闭 `安全模式`（点击 `打开社区插件`）。
|
||||
:::
|
||||
|
||||
3. 进入 `社区插件` -> `浏览`。
|
||||
|
||||
|
||||
4. 搜索 "NotionNext" 并点击 `安装`。
|
||||
|
||||
|
||||
5. 安装完成后，记得 `启用` 插件。
|
||||
|
||||
|
||||
启用后，你就可以在插件设置列表中找到 "Share to NotionNext"，并在下一步开始[配置你的数据库](./03-configuration.md)了。
|
||||
112
docs/zh/03-configuration.md
Normal file
112
docs/zh/03-configuration.md
Normal file
@@ -0,0 +1,112 @@
|
||||
---
|
||||
title: 配置数据库
|
||||
description: 在 Obsidian to NotionNext 插件中配置 Notion 数据库的指南
|
||||
---
|
||||
|
||||
# 配置数据库
|
||||
|
||||
在安装好插件并获取了 Notion API 令牌和数据库 ID 之后，你就可以开始配置要同步的数据库了。
|
||||
|
||||
首先，在 Obsidian 中打开插件设置。
|
||||
|
||||
|
||||
点击 “添加新数据库” 来创建一个新的数据库配置。
|
||||
|
||||
|
||||
|
||||
插件支持三种类型的数据库配置，你可以根据自己的需求选择。
|
||||
|
||||
- [数据库配置](#数据库配置)
|
||||
- [1️⃣ 通用数据库](#1️⃣-通用数据库)
|
||||
- [2️⃣ NotionNext 数据库](#2️⃣-notionnext-数据库)
|
||||
- [3️⃣ 自定义数据库](#3️⃣-自定义数据库)
|
||||
- [完成配置](#完成配置)
|
||||
|
||||
## 1️⃣ 通用数据库
|
||||
|
||||
这是最基础的数据库类型，适合大多数用户。
|
||||
|
||||
**配置项：**
|
||||
|
||||
- **数据库全名**: 给这个数据库配置起一个容易识别的名字。
|
||||
- **Notion API 令牌**: 你在第一步中获取的 API 令牌。
|
||||
- **数据库 ID**: 你在第二步中获取的数据库 ID。
|
||||
|
||||
**Notion 数据库要求：**
|
||||
|
||||
- 必须包含一个名为 `title` 的 `Title` 属性。
|
||||
- 必须包含一个名为 `tags` 的 `Multi-select` 属性。
|
||||
|
||||
|
||||
然后，像下面这样填写配置字段：
|
||||
|
||||
- **数据库全名 (Database Full Name)**: 你希望这个数据库在列表中显示的名字（例如：“学习资料库”）。
|
||||
- **数据库简称 (Database Abbreviate Name)**: 一个简短的别名（例如：“learning”）。
|
||||
- **同步 Notion 标签 (Notion Tags Sync)**: 如果希望将 Obsidian 的标签同步到 Notion，请启用此选项（**启用后，请确保你的笔记中包含 `tags`**）。
|
||||
- **自定义标题属性 (Customise title property)**: 你想用作主列的 Notion 数据库属性（默认为 `title`）。
|
||||
- **Notion API 令牌 (Notion API Token)**: 你在第一步中获取的 API 令牌。
|
||||
- **数据库 ID (Database ID)**: 你在第二步中获取的数据库 ID。
|
||||
|
||||
|
||||
|
||||
## 2️⃣ NotionNext 数据库
|
||||
|
||||
这个类型是为 [NotionNext](https://github.com/tangly1024/NotionNext) 博客系统的用户量身定制的，其属性已预设好以匹配 NotionNext 模板。
|
||||
|
||||
配置方式与通用数据库类似：
|
||||
|
||||
- **数据库全名**: 为这个数据库配置起一个名字。
|
||||
- **数据库简称**: 一个简短的别名。
|
||||
- **Notion API 令牌**: 你在第一步中获取的 API 令牌。
|
||||
- **数据库 ID**: 你在第二步中获取的数据库 ID。
|
||||
|
||||
|
||||
|
||||
## 3️⃣ 自定义数据库
|
||||
|
||||
这个类型为高级用户提供了极大的灵活性，允许你将 Obsidian 笔记中的任何 frontmatter 元数据映射到 Notion 数据库的任意属性。
|
||||
|
||||
首先，你需要像配置通用数据库一样填写基本信息：
|
||||
- **数据库全名**: 为这个数据库配置起一个名字。
|
||||
- **数据库简称**: 一个简短的别名。
|
||||
- **Notion API 令牌**: 你在第一步中获取的 API 令牌。
|
||||
- **数据库 ID**: 你在第二步中获取的数据库 ID。
|
||||
|
||||
|
||||
|
||||
填写完基本配置后，你就可以开始添加新的属性映射了。
|
||||
|
||||
你可以点击 `Add New Property` 按钮来创建一个新的属性映射。
|
||||
|
||||
首先，你需要添加标题属性的映射，这是 Notion 数据库正常工作所必需的。
|
||||
|
||||
|
||||
|
||||
::: tip
|
||||
请记住，"Notion 属性 (Notion Property)" 需要填写你在 Notion 数据库中的属性名称（区分大小写），而 "Frontmatter 键 (Frontmatter Key)" 则是你 Obsidian 笔记 frontmatter 中的键。
|
||||
:::
|
||||
|
||||
添加完标题属性后，你可以根据需要继续添加更多属性。
|
||||
|
||||
|
||||
目前，插件支持以下 Notion 属性类型：
|
||||
- Text
|
||||
- Number
|
||||
- Select
|
||||
- Multi-select
|
||||
- Date
|
||||
- Files & Media
|
||||
- Checkbox
|
||||
- URL
|
||||
- Email
|
||||
- Phone Number
|
||||
|
||||
|
||||
|
||||
::: info
|
||||
关联（Relation）和汇总（Rollup）类型暂时还不支持。
|
||||
:::
|
||||
|
||||
## 完成配置
|
||||
|
||||
配置完数据库后，请确保保存你的设置。现在，你可以通过命令面板或笔记右键菜单中的 “Share to NotionNext” 命令，开始将你的 Obsidian 笔记同步到配置好的 Notion 数据库了。
|
||||
12
docs/zh/04-sync.md
Normal file
12
docs/zh/04-sync.md
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: 同步笔记
|
||||
description: 如何使用 NotionNext 插件将你的 Obsidian 笔记同步到 Notion
|
||||
---
|
||||
|
||||
# 同步笔记
|
||||
|
||||
在插件设置中配置好你的 Notion 数据库后，你就可以开始将 Obsidian 笔记同步到 Notion 了。
|
||||
|
||||
要同步一篇笔记，只需打开你想要同步的笔记，然后从命令面板（`Ctrl/Cmd + P`）或笔记的右键菜单中选择 “Share to NotionNext” 命令。这会在你的 Notion 数据库中创建一个新页面，内容与你的 Obsidian 笔记完全一致。
|
||||
|
||||
你还可以为特定的笔记或文件夹设置自动同步。这样，你在 Obsidian 中对这些笔记所做的任何更改，都会自动反映到 Notion 中，非常方便。
|
||||
10
docs/zh/05-troubleshooting.md
Normal file
10
docs/zh/05-troubleshooting.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: 问题排查
|
||||
description: Obsidian to NotionNext 插件的常见问题与解决方案
|
||||
---
|
||||
|
||||
# 问题排查
|
||||
|
||||
如果问题依然存在，你可以在 GitHub 上[提交一个 Issue](https://github.com/jxpeng98/obsidian-to-NotionNext/issues)，并附上详细的错误信息和你的操作步骤，我会尽快帮助你。
|
||||
|
||||
你也可以通过 `Ctrl+Shift+I` (Windows/Linux) 或 `Cmd+Option+I` (Mac) 打开 Obsidian 的开发者工具，在控制台（Console）中查看是否有与 NotionNext 插件相关的错误日志，这对于定位问题非常有帮助。
|
||||
21
docs/zh/index.md
Normal file
21
docs/zh/index.md
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: 介绍
|
||||
description: 使用 Notion API 将文件分享到任何 Notion 数据库
|
||||
order: 0
|
||||
---
|
||||
|
||||
# Obsidian to NotionNext
|
||||
|
||||
在这份文档中，你将找到关于如何设置和使用 Obsidian to NotionNext 插件的指南和说明。这款插件可以让你使用 Notion API 将你的 Obsidian 笔记直接分享到 Notion 数据库。
|
||||
|
||||
本指南将引导你完成设置 Obsidian to NotionNext 插件的全过程。
|
||||
|
||||
[开始使用](./01-getting-started.md)
|
||||
|
||||
[安装插件](./02-installation.md)
|
||||
|
||||
[配置数据库](./03-configuration.md)
|
||||
|
||||
[同步笔记](./04-sync.md)
|
||||
|
||||
[问题排查](./05-troubleshooting.md)
|
||||
Reference in New Issue
Block a user