From be6f192dd80b0f466b893cf1f5f48b32149a215f Mon Sep 17 00:00:00 2001 From: Jiaxin Peng Date: Sun, 14 Jul 2024 21:51:53 +0100 Subject: [PATCH] Update readme file --- README.md | 67 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 38 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 32a3473..5581cbf 100644 --- a/README.md +++ b/README.md @@ -37,31 +37,31 @@ If you want to use this plugin, you need to follow the following steps to set up ### 1. Setting up the Notion API -1). go to [Notion API](https://www.notion.com/my-integrations) to create a new integration, and **copy the token**. +1). Go to [Notion API](https://www.notion.com/my-integrations) to create a new integration, and **copy the token**. - +![create-api](https://minioapi.pjx.ac.cn/img1/2024/07/4ffbcb9c531e889f35151333913beec7.gif) 2). Create a database in your Notion workspace. Open Notion, click top-left `Create` a new page` -> You can give a title for the page and press "/" Select 'Database - Full page'. - +![create-database](https://minioapi.pjx.ac.cn/img1/2024/07/f1bd993ed667bcc980a45194eb647c34.gif) -Rename the database properties to `title` and `tags`. +Rename the database properties to `title` and `tags`. **⚠️⚠️`title` is the title column! `tags` is lower case⚠️⚠️** - +![rename-title-tags](https://minioapi.pjx.ac.cn/img1/2024/07/20c7b81761195706dde6e7dae69edbc4.gif) 3). Add the Notion API integration. Click the right-top '...' -> connections -> connect to -> find the integration you created and connect it. - +![add-integration](https://minioapi.pjx.ac.cn/img1/2024/07/bf59397146d96727c96dac06515c6c22.gif) 4). Publish the database to the public. Click the 'Share' -> 'Publish' -> 'Publish' -> **copy the database id from the URL**. - +![share-publish](https://minioapi.pjx.ac.cn/img1/2024/07/5e5b9585cfa4a9086ef6704c3b48eacf.gif) ### 2. Setting up the plugin in Obsidian @@ -127,11 +127,11 @@ The basic information is identical to the general database and NotionNext databa 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. -![customise-add-property](https://minioapi.pjx.ac.cn/img1/2024/07/26c0d4548acb3d9ca0a4dda1c08e6a43.png) +![customise-add-property](https://minioapi.pjx.ac.cn/img1/2024/07/17cfbfa93d92404ff70d920302f15981.png) **⚠️⚠️⚠️**: **`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. **⚠️⚠️⚠️** -![title-column](https://minioapi.pjx.ac.cn/img1/2024/07/00b379c95c43dadc4b3e63086f0121fc.png) +![title-column](https://minioapi.pjx.ac.cn/img1/2024/07/0521b0aa6cedbe67bca4966bf79041ea.png) According to the previously shown database, you can use `title` as the `Title column`, and `Tags` as the property 1. @@ -157,7 +157,9 @@ 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. + +![general-sync](https://minioapi.pjx.ac.cn/img1/2024/07/6a690dc4b04d6b74134e9d3d76636c1b.gif) #### 2️⃣ note for NotionNext database @@ -182,10 +184,10 @@ tags: NotionID-pengjiaxin: 8ba573de-8fdf-4681-b063-c39d26e7860e --- -this is a test file +this is a test file ``` - +![notionnext-sync](https://minioapi.pjx.ac.cn/img1/2024/07/5539ec534e7a855ad87aa7949e5e836f.gif) #### 3️⃣ note for custom database @@ -193,7 +195,7 @@ this is a test file Use the previously created general database and rename `title` to `Name` and `tags` to `Tags` in Notion. - +![rename-notion](https://minioapi.pjx.ac.cn/img1/2024/07/e4d1c988be22353537998db897c7a471.gif) The front matter for the custom database is as follows: @@ -208,7 +210,7 @@ Tags: This is a test file. ``` - +![sync-custom](https://minioapi.pjx.ac.cn/img1/2024/07/973f17955cd921cca6b5007f0990eea4.gif) ##### sync more properties @@ -217,26 +219,33 @@ Add more property to the custom database. For example, we can add a `summary` an 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-property](https://minioapi.pjx.ac.cn/img1/2024/07/49716657adf0255a37fa214abf4716dc.gif) + 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 - - 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. - ``` + ![add-in-notion](https://minioapi.pjx.ac.cn/img1/2024/07/d193fe72ce3676bf643b0d1eb92dd4b7.gif) + + 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. + ``` + 6). Sync the note to Notion. - + + ![sync-custom](https://minioapi.pjx.ac.cn/img1/2024/07/0e4cfbd61acdaf813fd81ee6d046e067.gif) ---