mirror of
https://github.com/jxpeng98/obsidian-to-NotionNext
synced 2026-07-31 10:08:34 +08:00
docs: add documentation for Obsidian to NotionNext plugin setup and usage
This commit is contained in:
Jiaxin Peng
45
docs/en/01-getting-started.md
Normal file
45
docs/en/01-getting-started.md
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: Getting Started
|
||||
description: Guide to setting up the Obsidian to NotionNext plugin
|
||||
---
|
||||
|
||||
# Getting Started
|
||||
|
||||
## Get Notion API Token
|
||||
|
||||
Before using the plugin, you need to obtain an API Token from Notion to allow the plugin to access your Notion account.
|
||||
|
||||
1. Go to the [Notion API](https://www.notion.so/profile/integrations) page to create a new integration. You need to be logged into your Notion account.
|
||||
2. Click on `+ New integration`.
|
||||
|
||||
3. Fill in the required information:
|
||||
|
||||
4. Integration successfully created.
|
||||
|
||||
5. Enter the "Configure integration settings" page and **prepare to copy the API Token,** which you will need in the plugin settings.
|
||||
|
||||
|
||||
::: warning
|
||||
**⚠️ Note:** Keep your API Token secure and do not share it with others, as it grants access to your Notion data.
|
||||
:::
|
||||
|
||||
## Create a Notion Database and Connect Integration
|
||||
|
||||
Next, you need to create a Notion database to store the notes synced from Obsidian.
|
||||
|
||||
1. In your Notion workspace, click on `Create a new page` to create a new page.
|
||||
|
||||
|
||||
2. create a new page and select the `Database - Full page` option.
|
||||
|
||||
|
||||
3. Click the `...` menu in the top-right corner of the database page, go to `Connections`, and connect your newly created integration.
|
||||
|
||||
|
||||
4. Click `Share` -> `Publish` to publish the database to the web.
|
||||
|
||||
|
||||
5. Click and copy the **Database ID**.
|
||||
|
||||
|
||||
Next, you can proceed to install and configure the plugin in Obsidian by following the [Installation Guide](./02-installation.md).
|
||||
28
docs/en/02-installation.md
Normal file
28
docs/en/02-installation.md
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: Installation
|
||||
description: Guide to installing the Obsidian to NotionNext plugin
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
Once you have completed the previous section setup on the Notion side, you can install and configure the plugin in Obsidian.
|
||||
|
||||
1. Open Obsidian's `Settings`.
|
||||
|
||||
|
||||
2. Navigate to `Community plugins`.
|
||||
|
||||
::: tip
|
||||
If you haven't enabled community plugins before, you may need to turn off `Safe mode` first (`Turn on Community plugins`).
|
||||
:::
|
||||
|
||||
3. Go to `Community plugins` -> `Browse`.
|
||||
|
||||
|
||||
4. Search for "NotionNext" and click `Install`.
|
||||
|
||||
|
||||
5. After installation, enable the plugin.
|
||||
|
||||
|
||||
Now, once enabled, you can find the "Share to NotionNext" settings in the plugin settings tab to begin [configuring your databases](./03-configuration.md) in the next step.
|
||||
112
docs/en/03-configuration.md
Normal file
112
docs/en/03-configuration.md
Normal file
@@ -0,0 +1,112 @@
|
||||
---
|
||||
title: Configuration
|
||||
description: Guide to configuring Notion databases in the Obsidian to NotionNext plugin
|
||||
---
|
||||
|
||||
# Database Configuration
|
||||
|
||||
After installing the plugin and obtaining the Notion API token and Database ID, you can proceed to configure the databases you want to sync with.
|
||||
|
||||
First, open the plugin settings in Obsidian.
|
||||
|
||||
|
||||
Click "Add new database" to start creating a new database configuration.
|
||||
|
||||
|
||||
|
||||
In the plugin settings, you can add and configure the Notion databases you want to sync with. The plugin supports three types of database configurations.
|
||||
|
||||
- [Database Configuration](#database-configuration)
|
||||
- [1️⃣ General Database](#1️⃣-general-database)
|
||||
- [2️⃣ NotionNext Database](#2️⃣-notionnext-database)
|
||||
- [3️⃣ Custom Database](#3️⃣-custom-database)
|
||||
- [Finalizing Configuration](#finalizing-configuration)
|
||||
|
||||
## 1️⃣ General Database
|
||||
|
||||
This is the most basic database type and is suitable for most users.
|
||||
|
||||
**Configuration:**
|
||||
|
||||
- **Full Name**: A name for this database configuration.
|
||||
- **Notion API Token**: The API token you obtained in the first step.
|
||||
- **Database ID**: The database ID you obtained in the second step.
|
||||
|
||||
**Notion Database Requirements:**
|
||||
|
||||
- Must contain a `Title` property named `title`.
|
||||
- Must contain a `Multi-select` property named `tags`.
|
||||
|
||||
|
||||
Then, fill in the configuration fields as shown below:
|
||||
|
||||
- **Database Full Name**: the name you want to give this database to recognise it in the database list (e.g. "Learning Database").
|
||||
- **Database Abbreviate Name**: a short abbreviation for this database (e.g. "learning").
|
||||
- **Notion Tags Sync**: enable this option if you want to sync tags columns from Obsidian to Notion (**if you enable this option, make sure you add tags in your notes**).
|
||||
- **Customise title property**: the property in your Notion database that you want to use as the primary column (default is `title`).
|
||||
- **Notion API Token**: the API token you obtained in the first step.
|
||||
- **Database ID**: the database ID you obtained in the second step.
|
||||
|
||||
|
||||
|
||||
## 2️⃣ NotionNext Database
|
||||
|
||||
This type is specifically designed for users of the [NotionNext](https://github.com/tangly1024/NotionNext) blog system, with properties preset to match the NotionNext template.
|
||||
|
||||
Config the database similarly to the General Database type:
|
||||
|
||||
- **Database Full Name**: A name for this database configuration.
|
||||
- **Database Abbreviate Name**: A short abbreviation for this database.
|
||||
- **Notion API Token**: The API token you obtained in the first step.
|
||||
- **Database ID**: The database ID you obtained in the second step.
|
||||
|
||||
|
||||
|
||||
## 3️⃣ Custom Database
|
||||
|
||||
This type offers maximum flexibility for advanced users. It allows you to map any frontmatter metadata from your Obsidian notes to any property in your Notion database.
|
||||
|
||||
You should first config the database similarly to the General Database type:
|
||||
- **Database Full Name**: A name for this database configuration.
|
||||
- **Database Abbreviate Name**: A short abbreviation for this database.
|
||||
- **Notion API Token**: The API token you obtained in the first step.
|
||||
- **Database ID**: The database ID you obtained in the second step.
|
||||
|
||||
|
||||
|
||||
Once you have filled in the basic configuration, you can start to add new properties.
|
||||
|
||||
You can click the `Add New Property` button to create a new property mapping.
|
||||
|
||||
First, you need to add the title property mapping, which is required for the Notion database to function correctly.
|
||||
|
||||
|
||||
|
||||
::: tip
|
||||
Remember to set the "Notion Property" to the property name in your Notion database (case-sensitive) and the "Frontmatter Key" to the key in your Obsidian note's frontmatter.
|
||||
:::
|
||||
|
||||
After adding the title property, you can continue to add more properties as needed.
|
||||
|
||||
|
||||
For now, the plugin supports the following Notion property types:
|
||||
- Text
|
||||
- Number
|
||||
- Select
|
||||
- Multi-select
|
||||
- Date
|
||||
- Files & Media
|
||||
- Checkbox
|
||||
- URL
|
||||
- Email
|
||||
- Phone Number
|
||||
|
||||
|
||||
|
||||
::: info
|
||||
Relation and Rollup types are not supported yet.
|
||||
:::
|
||||
|
||||
## Finalizing Configuration
|
||||
|
||||
After configuring your database, make sure to save your settings. You can now start syncing your Obsidian notes to the configured Notion database by using the "Share to NotionNext" command from the command palette or the note context menu.
|
||||
12
docs/en/04-sync.md
Normal file
12
docs/en/04-sync.md
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Syncing Notes
|
||||
description: How to sync your Obsidian notes to Notion using the NotionNext plugin
|
||||
---
|
||||
|
||||
# Syncing Notes
|
||||
|
||||
After configuring your Notion database in the plugin settings, you can start syncing your Obsidian notes to Notion.
|
||||
|
||||
To sync a note, open the note you want to sync and use the "Share to NotionNext" command from the command palette or the note context menu. This will create a new page in your Notion database with the content of your Obsidian note.
|
||||
|
||||
You can also set up automatic syncing for specific notes or folders by configuring the plugin settings. This way, any changes you make to your Obsidian notes will be automatically reflected in Notion.
|
||||
10
docs/en/05-troubleshooting.md
Normal file
10
docs/en/05-troubleshooting.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: Troubleshooting
|
||||
description: Common issues and solutions for the Obsidian to NotionNext plugin
|
||||
---
|
||||
|
||||
# Troubleshooting
|
||||
|
||||
If the problem persists, you can [open an issue on GitHub](https://github.com/jxpeng98/obsidian-to-NotionNext/issues) with detailed error information and the steps you took.
|
||||
|
||||
You can find the error logs in Obsidian by going to developer tools (`Ctrl+Shift+I` or `Cmd+Option+I`) and checking the console for any error messages related to the NotionNext plugin.
|
||||
21
docs/en/index.md
Normal file
21
docs/en/index.md
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: Introduction
|
||||
description: Share files to any Notion database using the Notion API
|
||||
order: 0
|
||||
---
|
||||
|
||||
# Obsidian to NotionNext
|
||||
|
||||
In this documentation, you will find guides and instructions on how to set up and use the Obsidian to NotionNext plugin. This plugin allows you to share your Obsidian notes directly to Notion databases using the Notion API.
|
||||
|
||||
This guide will walk you through the process of setting up the Obsidian to NotionNext plugin.
|
||||
|
||||
[Getting Started](./01-getting-started.md)
|
||||
|
||||
[Installation](./02-installation.md)
|
||||
|
||||
[Configuration](./03-configuration.md)
|
||||
|
||||
[Syncing Notes](./04-sync.md)
|
||||
|
||||
[Troubleshooting](./05-troubleshooting.md)
|
||||
Reference in New Issue
Block a user