mirror of
https://github.com/jxpeng98/obsidian-to-NotionNext
synced 2026-07-30 17:18:36 +08:00
Compare commits
3 Commits
2.3.2
...
be6f192dd8
| Author | SHA1 | Date | |
|---|---|---|---|
| be6f192dd8 | |||
| 4ce1019094 | |||
| 095c608511 |
153
README.md
153
README.md
@@ -32,64 +32,77 @@
|
||||
- [x] ~~Support edit for database details in plugin settings. 支持编辑数据库详情~~
|
||||
|
||||
## How to use
|
||||
If you want to use this plugin, you need to follow the following steps to set up the plugin. The steps can be divided into two parts: setting up the Notion API and setting up the plugin in Obsidian.
|
||||
|
||||
### setting up the Notion API
|
||||
If you want to use this plugin, you need to follow the following steps to set up the plugin. The steps can be divided into two parts: setting up the Notion API and setting up the plugin in Obsidian.
|
||||
|
||||
1. go to [Notion API](https://www.notion.com/my-integrations) to create a new integration, and **copy the token**.
|
||||
|
||||
### 1. Setting up the Notion API
|
||||
|
||||
2. Create a database in your Notion workspace.
|
||||
1). Go to [Notion API](https://www.notion.com/my-integrations) to create a new integration, and **copy the token**.
|
||||
|
||||
Open Notion, clink top-left `Create a new page` -> You can give a title for the page and press "/" Select 'Database - Full page'.
|
||||
|
||||
|
||||
|
||||
2). Create a database in your Notion workspace.
|
||||
|
||||
Rename the database properties to `title` and `tags`.
|
||||
Open Notion, click top-left `Create` a new page` -> You can give a title for the page and press "/" Select 'Database - Full page'.
|
||||
|
||||
|
||||
|
||||
Rename the database properties to `title` and `tags`.
|
||||
**⚠️⚠️`title` is the title column! `tags` is lower case⚠️⚠️**
|
||||
|
||||
|
||||
3. Add the Notion API integration.
|
||||
|
||||
|
||||
3). Add the Notion API integration.
|
||||
|
||||
Click the right-top '...' -> connections -> connect to -> find the integration you created and connect it.
|
||||
|
||||
|
||||
4. Publish the database to the public.
|
||||
|
||||
|
||||
4). Publish the database to the public.
|
||||
Click the 'Share' -> 'Publish' -> 'Publish' -> **copy the database id from the URL**.
|
||||
|
||||
|
||||
|
||||
|
||||
### Setting up the plugin in Obsidian
|
||||
### 2. Setting up the plugin in Obsidian
|
||||
|
||||
1. Go to Obsidian settings -> community plugins -> search 'NotionNext' -> install it.
|
||||
|
||||
1). Go to Obsidian settings -> community plugins -> search 'NotionNext' -> install it.
|
||||
|
||||
|
||||
2). Open the plugin settings and create a new database.
|
||||
|
||||
2. Open the plugin settings and create a new database.
|
||||
|
||||
|
||||
### Create a database
|
||||
### 3. Create a database
|
||||
|
||||
**You can create three types of databases:**
|
||||
|
||||
#### General database
|
||||
General database is the default database, which only has the `title` and `tags` columns. **⚠️⚠️`title` and `tags` are lower case⚠️⚠️**
|
||||
#### 1️⃣ General database
|
||||
|
||||
General database is the default database, which only has the `title` and `tags` columns. **⚠️⚠️`title` and `tags` are lowercase⚠️⚠️**
|
||||
|
||||
|
||||
|
||||
The general is as follows:
|
||||
|
||||
- Full Name: the full name that you would like to give to the database.
|
||||
- Abbreviate Name: the abbreviation that you would like to give to the database.
|
||||
- Notion tags sync: whether you want to sync the tags column to Notion.
|
||||
- Customise title property: whether you want to change the `title` to another name (e.g., `name`).
|
||||
- Notion API token: the token you copied from the Notion API page.
|
||||
- Notion Database ID: the database ID you copied from the Notion database URL. (e.g., only copy `7158cd3f70ce4f60afd9da5bdf74fd0c` between `site/` and `?` **https://jxpeng.notion.site/7158cd3f70ce4f60afd9da5bdf74fd0c?v=380317ac53734fc0b2471243c13e618f&pvs=4**)
|
||||
- Notion Database ID: the database ID you copied from the Notion database URL. (e.g., only copy `7158cd3f70ce4f60afd9da5bdf74fd0c` between `site/` and `?`. `https://jxpeng.notion.site/7158cd3f70ce4f60afd9da5bdf74fd0c?v=380317ac5373sadasdas3c13e618f&pvs=4**`)
|
||||
|
||||
After setting, it should look like this:
|
||||
|
||||
|
||||
Once you click `save`, the new database will be created in the plugin settings and display in the detabase list.
|
||||
|
||||
|
||||
|
||||
Once you click `save`, the new database will be created in the plugin settings and display in the detabase list.
|
||||
|
||||
|
||||
|
||||
#### 2️⃣ NotionNext database
|
||||
|
||||
#### NotionNext database
|
||||
If you use [NotionNext](https://github.com/tangly1024/NotionNext) to set up your website, you can use the NotionNext database. (**All the properties are in lowercase, and you do not need to change the properties**)
|
||||
|
||||
|
||||
|
||||
Like the general database, you need to fill in the following information:
|
||||
@@ -99,7 +112,8 @@ Like the general database, you need to fill in the following information:
|
||||
- Notion API token: the token you copied from the Notion API page.
|
||||
- Notion Database ID: the database ID you copied from the Notion database URL.
|
||||
|
||||
#### Custom database
|
||||
#### 3️⃣ Custom database
|
||||
|
||||
The custom database is purely customised, and you can customise the properties you want to sync. (**All the properties are in lowercase, and you do not need to change the properties**)
|
||||
|
||||
|
||||
@@ -112,22 +126,27 @@ The basic information is identical to the general database and NotionNext databa
|
||||
- Notion Database ID: the database ID you copied from the Notion database URL.
|
||||
|
||||
After adding the information, You can click `Add New Property` to add the properties you want to sync. There is no limit to the number of properties you can add.
|
||||
|
||||
|
||||
|
||||
|
||||
**⚠️⚠️⚠️**: **`Title column` is the main property in the Notion database, which has the open button to open the underlying page.** You can select the type of all other properties. **⚠️⚠️⚠️**
|
||||
|
||||
|
||||
According to the previous shown database, you can use `title` as the `Title column`, and `Tags` as the property 1.
|
||||
|
||||
|
||||
|
||||
According to the previously shown database, you can use `title` as the `Title column`, and `Tags` as the property 1.
|
||||
|
||||
|
||||
|
||||
**Until now, you have set up the plugin in Obsidian. You can start syncing your notes to Notion.**
|
||||
|
||||
### Start syncing
|
||||
### 4. Start syncing
|
||||
|
||||
Create a new note in Obsidian, and fill in the front matter with the properties you want to sync.
|
||||
|
||||
#### note for general database
|
||||
#### 1️⃣ note for general database
|
||||
|
||||
For example, we can create a test note with the following front matter:
|
||||
|
||||
``` markdown
|
||||
---
|
||||
title: test
|
||||
@@ -138,9 +157,11 @@ This is a test file.
|
||||
|
||||
```
|
||||
|
||||
|
||||
After creating the note, you can click the `Share to NotionNext` button on the left sidebar to sync the note to Notion.
|
||||
|
||||
#### note for NotionNext database
|
||||
|
||||
|
||||
#### 2️⃣ note for NotionNext database
|
||||
|
||||
We use the following front matter for the NotionNext database:
|
||||
|
||||
@@ -163,16 +184,20 @@ tags:
|
||||
NotionID-pengjiaxin: 8ba573de-8fdf-4681-b063-c39d26e7860e
|
||||
---
|
||||
|
||||
this is a test file
|
||||
this is a test file
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
#### 3️⃣ note for custom database
|
||||
|
||||
#### note for custom database
|
||||
##### sync title and tags
|
||||
|
||||
1. Use the previous created general database and rename `title` to `Name` and `tags` to `Tags` in Notion. The front matter for the custom database is as follows:
|
||||
|
||||
Use the previously created general database and rename `title` to `Name` and `tags` to `Tags` in Notion.
|
||||
|
||||
|
||||
|
||||
The front matter for the custom database is as follows:
|
||||
|
||||
```markdown
|
||||
---
|
||||
@@ -183,20 +208,28 @@ Tags:
|
||||
---
|
||||
|
||||
This is a test file.
|
||||
```markdown
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
2. Add more property to the custom database. For example, we can add a `summary` and `date` property to the custom database.
|
||||
1. Click `Edit` in the plugin settings.
|
||||
##### sync more properties
|
||||
|
||||
Add more property to the custom database. For example, we can add a `summary` and `date` property to the custom database.
|
||||
|
||||
1). Click `Edit` in the plugin settings.
|
||||
|
||||
2. Click `Add` and add the `summary` and `date` property.
|
||||
|
||||
3. After adding the properties, you can see the properties in the plugin settings.
|
||||
2). Click `Add` and add the `summary` and `date` property.
|
||||
|
||||
|
||||
|
||||
3). After adding the properties, you can see the properties in the plugin settings.
|
||||
|
||||
4. Add the `summary` and `date` in Notion
|
||||
|
||||
5. Create a new note with the `summary` and `date` property.
|
||||
4). Add the `summary` and `date` in Notion
|
||||
|
||||
|
||||
|
||||
5). Create a new note with the `summary` and `date` property.
|
||||
|
||||
```markdown
|
||||
---
|
||||
Name: test-custom-more
|
||||
@@ -209,28 +242,14 @@ This is a test file.
|
||||
|
||||
This is a test file.
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
## 使用方法
|
||||
如果你想使用这个插件，你需要完成下边的七个步骤。
|
||||
1. 首先在你的Notion中创建一个数据库。
|
||||
2. 点击右上角的'分享' -> '发布' -> '发布' -> 然后复制URL中的数据库ID。(版本不同，可能id的形式也不同。只需要复制在？之前的纯数字部分应该就可以了)
|
||||
3. 去[Notion API](https://www.notion.com/my-integrations)创建一个新的API，然后复制token。
|
||||
4. 回到你创建的Notion数据库，点击右上角的'...' -> 连接 -> 连接到 -> 把你刚才创建的API绑定到你的数据库
|
||||
5. 回到Obsidian的设置 -> 社区插件 -> 搜索'NotionNext' -> 安装
|
||||
6. 在插件设置中创建一个数据库，然后填写数据库的详情和你想要同步的属性 (**注意：Notion会识别表头的大小写，一定要和notion中的表头保持大小写一致**)。
|
||||
- 你可以使用三种类型的数据库：
|
||||
- NotionNext: 用于NotionNext模板的数据库。(**默认全部小写**)
|
||||
- General: 用于普通的Notion数据库（**只有`title`和`tags`两个属性**）
|
||||
- Custom: 用于自定义属性的数据库（你可以自定义你想要同步的属性）
|
||||
7. 在Obsidian中创建一个新的笔记，然后在frontmatter中写入你想要的属性。
|
||||
|
||||
6). Sync the note to Notion.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Acknowledgement
|
||||
## Acknowledgment
|
||||
|
||||
Thanks to the [original author](https://github.com/EasyChris/obsidian-to-notion) for developing such a useful plugin that can synchronize Obsidian to Notion. However, the original repository can only sync Name and Tag information. For those like me who use [NotionNext](https://github.com/tangly1024/NotionNext) to set up their website, this presents some limitations. Every time I import, I need to make a lot of modifications.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user