Obsidian to NotionNext

Now, support both NotionNext and General databases with customised properties.

现在支持NotionNext和普通Notion数据库，可自定义数据库列表。

Precautions

For customised database users

⚠️⚠️⚠️: The existing customised database should be recreated if you want to update to version 2.3.0. The new version has a new database structure, and the old database structure is not compatible with the new version to build the index properly.

自定义数据库用户

⚠️⚠️⚠️: 如果你想要更新到2.3.0版本，你需要重新创建自定义数据库。新版本有一个新的数据库结构，旧的数据库结构无法构建索引。

TODO List

• Modify the Edit function for the custom properties. 改进自定义属性的编辑功能
• Support group upload with one click 支持一键多数据库上传
• Support custom properties for Notion General database. 支持自定义属性
• Support preview for database details in plugin settings. 支持预览数据库详情
• 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

1. go to Notion API to create a new integration, and copy the token.

2. Create a database in your Notion workspace.

Open Notion, clink 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.

Click the right-top '...' -> connections -> connect to -> find the integration you created and connect it.

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

1. Go to Obsidian settings -> community plugins -> search 'NotionNext' -> install it.

2. Open the plugin settings and create a new database.

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⚠️⚠️

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)

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.

NotionNext database

If you use 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:

• 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 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

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)

The basic information is identical to the general database and NotionNext database. You need to fill in the following information:

• 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 API token: the token you copied from the Notion API page.
• 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.

Until now, you have set up the plugin in Obsidian. You can start syncing your notes to Notion.

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

For example, we can create a test note with the following front matter:

---
title: test
tags: [test, web]
---

This is a test file. 

note for NotionNext database

We use the following front matter for the NotionNext database:

---
title: test-notionnext
titleicon: 📎
date: 2023-07-23
coverurl: https://img.jxpeng.dev/2023/08/843e27a210847f05a0f7cfb121fec100.jpg
type: Post
slug: test
status: Draft
category: test
summary: this is a summary for test post
icon: fa-solid fa-camera
password: "1234"
tags:
  - test
  - web
NotionID-pengjiaxin: 8ba573de-8fdf-4681-b063-c39d26e7860e
---

this is a test file 

note for custom database

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:

---
Name: test-custom
Tags:
  - test
  - web
---

This is a test file. 
```markdown

![custom-sync](https://minioapi.pjx.ac.cn/img1/2024/07/6881f569c7752d86899084531eb679d7.mp4)

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.
  ![edit](https://minioapi.pjx.ac.cn/img1/2024/07/f50639d8118b1f106d7bb29be5d3527b.png)
  2. Click `Add` and add the `summary` and `date` property.
  ![add-summary-date](https://minioapi.pjx.ac.cn/img1/2024/07/972af360c07dd2a0a94ead4bab1c0a70.mp4)
  3. After adding the properties, you can see the properties in the plugin settings.
  ![four properties](https://minioapi.pjx.ac.cn/img1/2024/07/63a0a0e09d537b1cf55cfdc49de4db1a.png)
  4. Add the `summary` and `date` in Notion
  ![summary-notion](https://minioapi.pjx.ac.cn/img1/2024/07/b6291a5122e5714e699608535394de98.mp4)
  5. Create a new note with the `summary` and `date` property.
  ```markdown
  ---
  Name: test-custom-more
  Tags:
    - test
    - web
  summary: this is a summary for test custom
  date: 2022-05-03
  ---

  This is a test file.

使用方法

如果你想使用这个插件，你需要完成下边的七个步骤。

1. 首先在你的Notion中创建一个数据库。
2. 点击右上角的'分享' -> '发布' -> '发布' -> 然后复制URL中的数据库ID。(版本不同，可能id的形式也不同。只需要复制在？之前的纯数字部分应该就可以了)
3. 去Notion API创建一个新的API，然后复制token。
4. 回到你创建的Notion数据库，点击右上角的'...' -> 连接 -> 连接到 -> 把你刚才创建的API绑定到你的数据库
5. 回到Obsidian的设置 -> 社区插件 -> 搜索'NotionNext' -> 安装
6. 在插件设置中创建一个数据库，然后填写数据库的详情和你想要同步的属性 (注意：Notion会识别表头的大小写，一定要和notion中的表头保持大小写一致)。
   • 你可以使用三种类型的数据库：
     • NotionNext: 用于NotionNext模板的数据库。(默认全部小写)
     • General: 用于普通的Notion数据库（只有title和tags两个属性）
     • Custom: 用于自定义属性的数据库（你可以自定义你想要同步的属性）
7. 在Obsidian中创建一个新的笔记，然后在frontmatter中写入你想要的属性。

---

Acknowledgement

Thanks to the original author 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 to set up their website, this presents some limitations. Every time I import, I need to make a lot of modifications.

Thus, based on the original author's work, I've added a feature to match the NotionNext template. This way, you can edit directly in Obsidian and publish with a single click after organizing.

---

Original README.md

Many Thanks for the original author's work. I've only made some changes to the original author's work. If you find this plugin useful, please give the original author a star.

Obsidian to Notion

Share of obsidian to Notion 中文文档

Sharing files from Obsidian to Notion with a single click, and Obsidian will automatically add the Notion share link

You are welcome to offer it a star if it can benefit you.

TODO

TODO Board

• support for custom page banner
• update the exsit page
• support for mult language
• support for auto copy the share link to clipboard
• support for mobile
• support tags thank for @jannikbuscha
• transfer the bi-link format like into the format that Notion supports.

How to use

Install the plugin

Marketplace download

Open obsidian setting -> Add plugin -> Search -> notion

BRAT

Enter BRAT into the plugin market center to find it. Add EasyChris/obsidian-to-notion to the list of BRAT plugins that have been installed. Return to the plugin center and turn it on.

Manual installation

cd YOUR_OBSIDIAN_FOLDER/.obsidian/plugins/
git clone https://github.com/EasyChris/obsidian-to-notion.git

Apply Notion API

Official reference documentation: https://developers.notion.com/docs

Step 1: Create integration

Go to https://www.notion.com/my-integrations Once created, copy secrets toekn

Note

database first custom name must be "Name", otherwise sync to notion will be failed

Step 2: Share a database with your integration

Create a new page (with public permissions) Create a new database in the page -> you need full page database

Add integration to your new database

Step 3: Copy the database ID

https://www.notion.so/myworkspace/a8aec43384f447ed84390e8e42c2e089?v=...
                                  | --------- Database ID --------|

Open the plugin configuration

Fill the configuration with the NOTION_API_KEY and DATABASE_ID you got

Upload file content to notion

Click the uploadCommand notion button A share link will be automatically generated after successful uploadCommand

Banner URL [option]

Banner url must be a image url like: https://i.imgur.com/xxx.jpg If you don't want to use banner, leave it blank

Convert Tags [option]

Transfer the Obsidian tags to the Notion table. It requires the column with the name 'Tags'.

Add tags to your notion page

• open plugin convert tags

• add tags in the head

---
tags: [tag1,tag2]
---

this is test tags

---
tags:
  - tag4
---

this is test tags

Thanks for @jannikbuscha contribution

Notion ID [option]

Notion ID is the your notion site ID that you want to share the file to. if you don't write it, notion will share to the default link like: https://www.notion.so/myworkspace/a8aec43384f447ed84390 that visit this page need to redirect to your site url if you write the Notion ID, it will share to the page link like: https://your_user_name.notion.site/myworkspace/a8aec43384f447ed84390. The visiter don't need to redirect url.

Sync image to Notion

To sync images to your oss or cos bucket, use the Obsidian Image Auto Upload Plugin.

Development

git clone https://github.com/EasyChris/obsidian-to-notion.git
yarn install
yarn dev

Release

node update-version.js
./release.sh

Thanks

Development Process | Obsidian Plugin Development Documentation

GitHub - devbean/obsidian-wordpress: An obsidian plugin for publishing docs to WordPress.

GitHub - obsidianmd/obsidian-api

GitHub - Easychris/obsidian-to-notion: Obsidian Weread Plugin is an plugin to sync Weread(微信读书) hightlights and annotations into your Obsidian Vault.

GitHub - Quorafind/Obsidian-Memos: A quick capture plugin for Obsidian, all data from your notes.

https://github.com/jannikbuscha/obsidian-to-notion

License

GNU GPLv3