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

Added english readme

Browse Source
This commit is contained in:
chris
2022-05-24 15:30:45 +08:00
parent e3669e7a83
commit 208fb40f72
4 changed files with 138 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
README-zh.md Normal file
View File

@@ -0,0 +1,69 @@
Obsidian share to Notion
将obsidian文件一键分享到Notion,并在obsidian中添加Notion分享链接
![](./doc/1.gif)
# 使用方式
## 安装插件
### BRAT
插件中中心搜索 BRAT
添加 `EasyChris/obsidian-to-notion` 到 BRAT 插件安装列表中
返回插件中心启用即可
### 手动安装
```
cd YOUR_OBSIDIAN_FOLDER/.obsidian/plugins/
git clone https://github.com/EasyChris/obsidian-to-notion.git
```
### 市场下载
因为暂时还未上架，所以请通过BRAT安装
## 申请 Notion API
官方参考文档：[https://developers.notion.com/docs](https://developers.notion.com/docs)
### 第 1 步：创建integration。
转到 [https://www.notion.com/my-integrations](https://www.notion.com/my-integrations)
创建完成之后，复制`secrets toekn`
![](https://files.readme.io/2ec137d-093ad49-create-integration.gif)
### 第2步：与你的集成共享一个数据库
新建一个的page（权限为公开）
在page中新建一个数据库 -> 需要`full page database`
![](./doc/3.gif)
将`integration`添加到你的新建的数据库中
![](https://files.readme.io/0a267dd-share-database-with-integration.gif)
### 第三步：复制database ID
```
https://www.notion.so/myworkspace/a8aec43384f447ed84390e8e42c2e089?v=...
|--------- Database ID --------|
```
## 打开插件配置
将得到的 `NOTION_API_KEY` 和 `DATABASE_ID`填入配置当中
![](./doc/2.png)
## 上传文件内容到notion
点击上传notion的按钮
![](./doc/4.png)
上传成功之后会自动生成一个分享链接
![](./doc/5.png)
# 请我喝杯咖啡
[顿顿饭](https://dun.mianbaoduo.com/@easy)
# 感谢
[开发流程 | Obsidian 插件开发文档](https://luhaifeng666.github.io/obsidian-plugin-docs-zh/zh/getting-started/development-workflow.html)
[GitHub - devbean/obsidian-wordpress: An obsidian plugin for publishing docs to WordPress.](https://github.com/devbean/obsidian-wordpress)
[GitHub - obsidianmd/obsidian-api](https://github.com/obsidianmd/obsidian-api)
[GitHub - zhaohongxuan/obsidian-weread-plugin: Obsidian Weread Plugin is an plugin to sync Weread(微信读书) hightlights and annotations into your Obsidian Vault.](https://github.com/zhaohongxuan/obsidian-weread-plugin)

58
README.md
View File

@@ -1,66 +1,66 @@
Obsidian share to Notion Obsidian share to Notion
将obsidian文件一键分享到Notion,并在obsidian中添加Notion分享链接 Share obsidian files to Notion with one click, and auto add Notion share link in obsidian
![](./doc/1.gif) ![](./doc/1.gif)
# 使用方式 # How to use
## 安装插件 ## Install the plugin
### BRAT ### BRAT
插件中中心搜索 BRAT Search for `BRAT` plugin in the plugin market center
添加 `EasyChris/obsidian-to-notion` 到 BRAT 插件安装列表中 Add `EasyChris/obsidian-to-notion` to the list of installed BRAT plugins
返回插件中心启用即可 Go back to the plugin center and enable it
### 手动安装 ### Manual installation
``` ```
cd YOUR_OBSIDIAN_FOLDER/.obsidian/plugins/ cd YOUR_OBSIDIAN_FOLDER/.obsidian/plugins/
git clone https://github.com/EasyChris/obsidian-to-notion.git git clone https://github.com/EasyChris/obsidian-to-notion.git
``` ```
### 市场下载 ### Marketplace download
因为暂时还未上架，所以请通过BRAT安装 Please install via BRAT because it's not on the market yet
## 申请 Notion API ## Apply Notion API
官方参考文档：[https://developers.notion.com/docs](https://developers.notion.com/docs) Official reference documentation: [https://developers.notion.com/docs](https://developers.notion.com/docs)
### 第 1 步：创建integration。 ### Step 1: Create integration.
转到 [https://www.notion.com/my-integrations](https://www.notion.com/my-integrations) Go to [https://www.notion.com/my-integrations](https://www.notion.com/my-integrations)
创建完成之后，复制`secrets toekn` Once created, copy `secrets toekn`
![](https://files.readme.io/2ec137d-093ad49-create-integration.gif) ![](https://files.readme.io/2ec137d-093ad49-create-integration.gif)
### 第2步：与你的集成共享一个数据库 ### Step 2: Share a database with your integration
新建一个的page（权限为公开） Create a new page (with public permissions)
在page中新建一个数据库 -> 需要`full page database` Create a new database in the page -> you need `full page database`
![](./doc/3.gif) ![](./doc/3.gif)
将`integration`添加到你的新建的数据库中 Add `integration` to your new database
![](https://files.readme.io/0a267dd-share-database-with-integration.gif) ![](https://files.readme.io/0a267dd-share-database-with-integration.gif)
### 第三步：复制database ID ### Step 3: Copy the database ID
``` ```
https://www.notion.so/myworkspace/a8aec43384f447ed84390e8e42c2e089?v=... https://www.notion.so/myworkspace/a8aec43384f447ed84390e8e42c2e089?v=...
|--------- Database ID --------| | --------- Database ID --------|
``` ```
## 打开插件配置 ## Open the plugin configuration
将得到的 `NOTION_API_KEY` 和 `DATABASE_ID`填入配置当中 Fill the configuration with the `NOTION_API_KEY` and `DATABASE_ID` you got
![](./doc/2.png) ![](./doc/2.png)
## 上传文件内容到notion ## Upload file content to notion
点击上传notion的按钮 Click the upload notion button
![](./doc/4.png) ![](./doc/4.png)
上传成功之后会自动生成一个分享链接 A share link will be automatically generated after successful upload
![](./doc/5.png) ![](./doc/5.png)
# 请我喝杯咖啡 # Buy me a cup of coffee.
[顿顿饭](https://dun.mianbaoduo.com/@easy) [Buy me a coffee](https://dun.mianbaoduo.com/@easy)
# 感谢 # Thanks
[开发流程 | Obsidian 插件开发文档](https://luhaifeng666.github.io/obsidian-plugin-docs-zh/zh/getting-started/development-workflow.html) [Development Process | Obsidian Plugin Development Documentation](https://luhaifeng666.github.io/obsidian-plugin-docs-zh/zh/getting-started/development-workflow.html)
[GitHub - devbean/obsidian-wordpress: An obsidian plugin for publishing docs to WordPress.](https://github.com/devbean/obsidian-wordpress) [GitHub - devbean/obsidian-wordpress: An obsidian plugin for publishing docs to WordPress.](https://github.com/devbean/obsidian-wordpress)

16
manifest.json
View File

@@ -1,10 +1,10 @@
{ {
"id": "obsidian-to-notion", "id": "obsidian-to-notion",
"name": "Obsidian shared to Notion", "name": "Obsidian shared to Notion",
"version": "0.3.4", "version": "0.3.5",
"minAppVersion": "0.0.1", "minAppVersion": "0.0.1",
"description": "This is a plugin for Obsidian. This plugin share obsidian md file to notion with notion api", "description": "This is a plugin for Obsidian. This plugin share obsidian md file to notion with notion api",
"author": "Easychris", "author": "Easychris",
"authorUrl": "https://github.com/EasyChris/obsidian-to-notion", "authorUrl": "https://github.com/EasyChris/obsidian-to-notion",
"isDesktopOnly": false "isDesktopOnly": false
} }

60
package.json
View File

@@ -1,32 +1,32 @@
{ {
"name": "obsidian-to-notion", "name": "obsidian-to-notion",
"version": "0.3.4", "version": "0.3.5",
"type": "module", "type": "module",
"description": "This is a plugin for Obsidian. This plugin share obsidian md file to notion with notion api", "description": "This is a plugin for Obsidian. This plugin share obsidian md file to notion with notion api",
"main": "main.js", "main": "main.js",
"scripts": { "scripts": {
"dev": "node esbuild.config.mjs", "dev": "node esbuild.config.mjs",
"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production", "build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
"version": "node version-bump.mjs && git add manifest.json versions.json" "version": "node version-bump.mjs && git add manifest.json versions.json"
}, },
"keywords": [], "keywords": [],
"author": "", "author": "",
"license": "GNU GPLv3", "license": "GNU GPLv3",
"devDependencies": { "devDependencies": {
"@types/node": "^17.0.35", "@types/node": "^17.0.35",
"@types/yaml-front-matter": "^4.1.0", "@types/yaml-front-matter": "^4.1.0",
"@typescript-eslint/eslint-plugin": "^5.2.0", "@typescript-eslint/eslint-plugin": "^5.2.0",
"@typescript-eslint/parser": "^5.2.0", "@typescript-eslint/parser": "^5.2.0",
"builtin-modules": "^3.2.0", "builtin-modules": "^3.2.0",
"esbuild": "0.13.12", "esbuild": "0.13.12",
"obsidian": "latest", "obsidian": "latest",
"tslib": "2.3.1", "tslib": "2.3.1",
"typescript": "4.4.4" "typescript": "4.4.4"
}, },
"dependencies": { "dependencies": {
"@tryfabric/martian": "^1.2.0", "@tryfabric/martian": "^1.2.0",
"https-proxy-agent": "^5.0.1", "https-proxy-agent": "^5.0.1",
"yaml": "^2.1.0", "yaml": "^2.1.0",
"yaml-front-matter": "^4.1.1" "yaml-front-matter": "^4.1.1"
} }
} }