jxpeng98/obsidian-to-NotionNext
1
0
Fork 0
mirror of https://github.com/jxpeng98/obsidian-to-NotionNext synced 2026-07-29 16:35:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: enhance auto sync documentation with frontmatter key configuration and examples

Browse Source
This commit is contained in:
Jiaxin Peng
2025-11-06 16:50:50 +00:00
parent 943ec6af6d
commit e9355aaf92
2 changed files with 69 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/en/03-configuration.md
View File

@@ -22,6 +22,21 @@ In the plugin settings, you can add and configure the Notion databases you want
- [3️⃣ Custom Database](#3️⃣-custom-database)
- [Finalizing Configuration](#finalizing-configuration)
## Auto Sync Frontmatter Entry
If you enable auto sync, the plugin needs a frontmatter entry that lists which configured databases should receive updates. You can customise the name of this entry in **Settings → Auto Sync Frontmatter Key** (default: `autosync-database`). Use any text you like—letters, numbers, emojis, or other scripts are all supported.
In your note's frontmatter, add the configured key and list the database abbreviations you created in the settings:
```yaml
---
title: My Article
autosync-database: [blog, ideas]
---
```
The entry can be a YAML list or comma-separated string, and manual uploads will automatically add the current database abbreviation if it is missing. If you change the key name in settings, update your frontmatter to match the new value.
## 1️⃣ General Database
This is the most basic database type and is suitable for most users.
@@ -109,4 +124,4 @@ 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.
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.