mirror of
https://github.com/jxpeng98/obsidian-to-NotionNext
synced 2026-07-29 08:08:34 +08:00
Added english readme
This commit is contained in:
chris
69
README-zh.md
Normal file
69
README-zh.md
Normal file
@@ -0,0 +1,69 @@
|
||||
Obsidian share to Notion
|
||||
|
||||
将obsidian文件一键分享到Notion,并在obsidian中添加Notion分享链接
|
||||
|
||||
|
||||
|
||||
# 使用方式
|
||||
## 安装插件
|
||||
### 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`
|
||||
|
||||
|
||||
### 第2步：与你的集成共享一个数据库
|
||||
新建一个的page（权限为公开）
|
||||
在page中新建一个数据库 -> 需要`full page database`
|
||||
|
||||
|
||||
将`integration`添加到你的新建的数据库中
|
||||
|
||||
|
||||
|
||||
### 第三步：复制database ID
|
||||
|
||||
```
|
||||
https://www.notion.so/myworkspace/a8aec43384f447ed84390e8e42c2e089?v=...
|
||||
|--------- Database ID --------|
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 打开插件配置
|
||||
将得到的 `NOTION_API_KEY` 和 `DATABASE_ID`填入配置当中
|
||||
|
||||
|
||||
## 上传文件内容到notion
|
||||
点击上传notion的按钮
|
||||
|
||||
上传成功之后会自动生成一个分享链接
|
||||
|
||||
|
||||
|
||||
# 请我喝杯咖啡
|
||||
|
||||
[顿顿饭](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
58
README.md
@@ -1,66 +1,66 @@
|
||||
Obsidian share to Notion
|
||||
|
||||
将obsidian文件一键分享到Notion,并在obsidian中添加Notion分享链接
|
||||
Share obsidian files to Notion with one click, and auto add Notion share link in obsidian
|
||||
|
||||
|
||||
|
||||
# 使用方式
|
||||
## 安装插件
|
||||
# How to use
|
||||
## Install the plugin
|
||||
### BRAT
|
||||
插件中中心搜索 BRAT
|
||||
添加 `EasyChris/obsidian-to-notion` 到 BRAT 插件安装列表中
|
||||
返回插件中心启用即可
|
||||
### 手动安装
|
||||
Search for `BRAT` plugin in the plugin market center
|
||||
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/
|
||||
git clone https://github.com/EasyChris/obsidian-to-notion.git
|
||||
```
|
||||
### 市场下载
|
||||
因为暂时还未上架，所以请通过BRAT安装
|
||||
### Marketplace download
|
||||
Please install via BRAT because it's not on the market yet
|
||||
|
||||
## 申请 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`
|
||||
## Apply Notion API
|
||||
Official reference documentation: [https://developers.notion.com/docs](https://developers.notion.com/docs)
|
||||
### Step 1: Create integration.
|
||||
Go to [https://www.notion.com/my-integrations](https://www.notion.com/my-integrations)
|
||||
Once created, copy `secrets toekn`
|
||||
|
||||
|
||||
### 第2步：与你的集成共享一个数据库
|
||||
新建一个的page（权限为公开）
|
||||
在page中新建一个数据库 -> 需要`full page database`
|
||||
### 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`
|
||||
|
||||
|
||||
将`integration`添加到你的新建的数据库中
|
||||
Add `integration` to your new database
|
||||
|
||||
|
||||
|
||||
### 第三步：复制database ID
|
||||
### Step 3: Copy the database ID
|
||||
|
||||
```
|
||||
https://www.notion.so/myworkspace/a8aec43384f447ed84390e8e42c2e089?v=...
|
||||
|--------- Database ID --------|
|
||||
| --------- Database ID --------|
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 打开插件配置
|
||||
将得到的 `NOTION_API_KEY` 和 `DATABASE_ID`填入配置当中
|
||||
## Open the plugin configuration
|
||||
Fill the configuration with the `NOTION_API_KEY` and `DATABASE_ID` you got
|
||||
|
||||
|
||||
## 上传文件内容到notion
|
||||
点击上传notion的按钮
|
||||
## Upload file content to notion
|
||||
Click the upload notion button
|
||||
|
||||
上传成功之后会自动生成一个分享链接
|
||||
A share link will be automatically generated after successful upload
|
||||
|
||||
|
||||
|
||||
# 请我喝杯咖啡
|
||||
# Buy me a cup of coffee.
|
||||
|
||||
[顿顿饭](https://dun.mianbaoduo.com/@easy)
|
||||
[Buy me a coffee](https://dun.mianbaoduo.com/@easy)
|
||||
|
||||
# 感谢
|
||||
[开发流程 | Obsidian 插件开发文档](https://luhaifeng666.github.io/obsidian-plugin-docs-zh/zh/getting-started/development-workflow.html)
|
||||
# Thanks
|
||||
[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)
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
{
|
||||
"id": "obsidian-to-notion",
|
||||
"name": "Obsidian shared to Notion",
|
||||
"version": "0.3.4",
|
||||
"minAppVersion": "0.0.1",
|
||||
"description": "This is a plugin for Obsidian. This plugin share obsidian md file to notion with notion api",
|
||||
"author": "Easychris",
|
||||
"authorUrl": "https://github.com/EasyChris/obsidian-to-notion",
|
||||
"isDesktopOnly": false
|
||||
}
|
||||
"id": "obsidian-to-notion",
|
||||
"name": "Obsidian shared to Notion",
|
||||
"version": "0.3.5",
|
||||
"minAppVersion": "0.0.1",
|
||||
"description": "This is a plugin for Obsidian. This plugin share obsidian md file to notion with notion api",
|
||||
"author": "Easychris",
|
||||
"authorUrl": "https://github.com/EasyChris/obsidian-to-notion",
|
||||
"isDesktopOnly": false
|
||||
}
|
||||
62
package.json
62
package.json
@@ -1,32 +1,32 @@
|
||||
{
|
||||
"name": "obsidian-to-notion",
|
||||
"version": "0.3.4",
|
||||
"type": "module",
|
||||
"description": "This is a plugin for Obsidian. This plugin share obsidian md file to notion with notion api",
|
||||
"main": "main.js",
|
||||
"scripts": {
|
||||
"dev": "node esbuild.config.mjs",
|
||||
"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
|
||||
"version": "node version-bump.mjs && git add manifest.json versions.json"
|
||||
},
|
||||
"keywords": [],
|
||||
"author": "",
|
||||
"license": "GNU GPLv3",
|
||||
"devDependencies": {
|
||||
"@types/node": "^17.0.35",
|
||||
"@types/yaml-front-matter": "^4.1.0",
|
||||
"@typescript-eslint/eslint-plugin": "^5.2.0",
|
||||
"@typescript-eslint/parser": "^5.2.0",
|
||||
"builtin-modules": "^3.2.0",
|
||||
"esbuild": "0.13.12",
|
||||
"obsidian": "latest",
|
||||
"tslib": "2.3.1",
|
||||
"typescript": "4.4.4"
|
||||
},
|
||||
"dependencies": {
|
||||
"@tryfabric/martian": "^1.2.0",
|
||||
"https-proxy-agent": "^5.0.1",
|
||||
"yaml": "^2.1.0",
|
||||
"yaml-front-matter": "^4.1.1"
|
||||
}
|
||||
}
|
||||
"name": "obsidian-to-notion",
|
||||
"version": "0.3.5",
|
||||
"type": "module",
|
||||
"description": "This is a plugin for Obsidian. This plugin share obsidian md file to notion with notion api",
|
||||
"main": "main.js",
|
||||
"scripts": {
|
||||
"dev": "node esbuild.config.mjs",
|
||||
"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
|
||||
"version": "node version-bump.mjs && git add manifest.json versions.json"
|
||||
},
|
||||
"keywords": [],
|
||||
"author": "",
|
||||
"license": "GNU GPLv3",
|
||||
"devDependencies": {
|
||||
"@types/node": "^17.0.35",
|
||||
"@types/yaml-front-matter": "^4.1.0",
|
||||
"@typescript-eslint/eslint-plugin": "^5.2.0",
|
||||
"@typescript-eslint/parser": "^5.2.0",
|
||||
"builtin-modules": "^3.2.0",
|
||||
"esbuild": "0.13.12",
|
||||
"obsidian": "latest",
|
||||
"tslib": "2.3.1",
|
||||
"typescript": "4.4.4"
|
||||
},
|
||||
"dependencies": {
|
||||
"@tryfabric/martian": "^1.2.0",
|
||||
"https-proxy-agent": "^5.0.1",
|
||||
"yaml": "^2.1.0",
|
||||
"yaml-front-matter": "^4.1.1"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user