Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rujuu-prog/markdown2notion
🔀 Convert markdown files to notion database. The folder structure is also fully represented as tags in notion.
https://github.com/rujuu-prog/markdown2notion
javascript markdown notion notion-api npm npm-module oss typescript
Last synced: 2 months ago
JSON representation
🔀 Convert markdown files to notion database. The folder structure is also fully represented as tags in notion.
- Host: GitHub
- URL: https://github.com/rujuu-prog/markdown2notion
- Owner: Rujuu-prog
- License: mit
- Created: 2023-03-28T08:03:21.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-02T17:25:00.000Z (4 months ago)
- Last Synced: 2024-10-05T11:08:13.961Z (3 months ago)
- Topics: javascript, markdown, notion, notion-api, npm, npm-module, oss, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/markdown2notion
- Size: 517 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README-JP.md
- License: LICENSE
Awesome Lists containing this project
README
# markdown2notion
[](https://badge.fury.io/js/markdown2notion) [](https://opensource.org/licenses/MIT) [](https://codecov.io/github/Rujuu-prog/markdown2notion)
notionのDBにmarkdownファイルを変換するツールです。フォルダ構造もタグとして表現されます。
> notionのtokenの発行方法やDBとの紐付けかたは[こちら](https://developers.notion.com/docs/getting-started)を参照してください。
## 🔗 リンク
English👉[README.md](https://github.com/Rujuu-prog/markdownToNotion/blob/main/README.md)
## 🔽 インストール方法
```bash
npm install markdown2notion
```
```bash
yarn add markdown2notion
```
## 🔧 使い方
javascriptとtypescriptで使えます。
### markdownToNotion()
```typescript
import {markdownToNotion} from 'markdown2notion'
async function main(){
try{
await markdownToNotion(
'notion_token',
'notion database id',
'markdownファイルが入っているフォルダのパス',
'ファイル名を表示するnotionの列名。 デフォルトはTitle',
'タグとしてフォルダ名を表示する列名。 デフォルトはTags')
} catch (error) {
console.error(error);
}
}
```
### searchPage()
> ページのURLはmarkdownToNotion()を使うたびに変更されるため、URLを使って何かしたい場合は、この関数でページのURLを取得してください。
```typescript
import {searchPage} from 'markdown2notion'
async function main(){
try{
const result = await searchPage(
'notion token',
'notion database id',
'ファイル名を表示するnotionの列名。 デフォルトはTitle',
'タグとしてフォルダ名を表示する列名。 デフォルトはTags'
'検索したいファイル名',
'検索したいファイルが入っているフォルダ名。配列で指定。'
)
// 同じファイル名のファイルが存在している場合、複数のページが返ってきます。
console.log(result)// notionのpageのobjectが返ってきます。urlはresult['results'][0]['url']とかで取れます。
} catch (error) {
console.error(error)
}
}
```
## 🔰 使用例
### 🔽markdownToNotion()
### フォルダ構成
```bash
├── docs
│ ├── sample1
│ │ ├── sample1_1
│ │ │ ├── sampleContent1_1.md
│ │ ├── sampleContent1.md
│ ├── sample2
│ │ ├── sampleContent2.md
├── src
│ ├── index.ts
├── .env
```
### notion DB
### マークダウンファイルのサンプル
[Sample Markdown Folder](https://github.com/Rujuu-prog/markdown2notion/tree/main/sample/docs)
### index.ts
```typescript
import {markdownToNotion} from 'markdown2notion'
import * as dotenv from 'dotenv'
async function main() {
dotenv.config()
const token = process.env.NOTION_TOKEN
const databaseId = process.env.NOTION_DATABASE_ID
try {
await markdownToNotion(token, databaseId, 'docs', 'Title', 'Tags');
} catch (error) {
console.error(error);
}
}
main()
```
### .env
```.env
NOTION_TOKEN=secret_xxxxxxxxxxxxxx
NOTION_DATABASE_ID=xxxxxxxxxxxxxxx
```
### index.tsの実行結果
フォルダ構造がタグとして表現されます。
タグでフィルタリングすることで、見たいファイルをすぐに探すことができます。
### 🔽searchPage()
### index.ts
```typescript
import {searchPage} from 'markdown2notion'
import * as dotenv from 'dotenv'
async function main() {
dotenv.config()
const token = process.env.NOTION_TOKEN
const databaseId = process.env.NOTION_DATABASE_ID
const title = 'sampleContent1_1';
const tags = ['sample1_1'];
try {
const result = await searchPage(token, databaseId, 'Title', 'Tags', title, tags);
console.log(result['results'][0]['url']);
} catch (error) {
console.error('Error searching for page:', error);
}
}
main()
```
### result
```bash
{
object: 'list',
results: [
{
object: 'page',
id: '33.....',
created_time: '2023-03-29T14:15:00.000Z',
last_edited_time: '2023-03-29T14:15:00.000Z',
created_by: [Object],
last_edited_by: [Object],
cover: null,
icon: null,
parent: [Object],
archived: false,
properties: [Object],
url: 'https://www.notion.so/sampleContent1_1-33...'
}
],
next_cursor: null,
has_more: false,
type: 'page',
page: {}
}
```
👀 注意点
操作対象のnotionのDB上に、ファイル名と同じページがある場合は上書きされます。
## ライセンス
MIT