@notion-md-converter/qiita
Version:
Notion to Qiita Markdown Converter
108 lines (70 loc) • 2.71 kB
Markdown
# @notion-md-converter/qiita
NotionページをQiitaのMarkdownに変換するためのパッケージです。
## 🚀 インストール
```
# JavaScriptの場合
npm install @notion-md-converter/core @notion-md-converter/qiita
# TypeScriptの場合
npm install @notion-md-converter/core @notion-md-converter/qiita @notion-md-converter/types
```
## 📖 使い方
```typescript
import { $getPageFullContent } from "@notion-md-converter/core";
import { NotionQiitaMarkdownConverter } from "@notion-md-converter/qiita";
import { Client } from "@notionhq/client";
const client = new Client({
auth: API_KEY,
});
const pageId = "some-page-id";
// このライブラリのNotion APIヘルパー
// Notion Blockの子要素を再帰的に取得
const content = await $getPageFullContent(client, pageId);
// Markdownに変換
const executor = new NotionQiitaMarkdownConverter();
const result = executor.execute(content);
```
## ブロックオプション
### コールアウト
背景色とテキスト色の設定に基づいて、Qiitaノートのinfo、warn、alertスタイルを選択できます。
| 色 | note |
| ------ | ----- |
| yellow | warn |
| red | alert |
| その他 | info |
### コード
コールアウトメタデータを使用してdiff表示を有効にできます
| メタデータ | 値 |
| ------ | ---- |
| diff | `true`に設定するとdiff表示が有効になります |
### 埋め込み
#### CodePen
| メタデータ | 値 |
| ----------- | ---------------- |
| height | iframeの高さ |
| defaultTab | デフォルトタブ |
#### Figma
| メタデータ | 値 |
| ----------- | ---------------- |
| height | iframeの高さ |
| width | iframeの幅 |
#### Google Slide
| メタデータ | 値 |
| ----------- | ---------------- |
| height | iframeの高さ |
| width | iframeの幅 |
#### YouTube
| メタデータ | 値 |
| ----------- | ---------------- |
| height | iframeの高さ |
| width | iframeの幅 |
#### Speaker Deck
| メタデータ | 値 |
| ----------- | ---------------- |
| id | Speaker Deck ID |
IDが指定されていない場合は、リンクカードとして表示されます。
### ビデオ
YouTube動画は埋め込みとして表示されます。その他の動画はvideoタグを使用します。
## ライセンス
MITライセンスの下で配布されています。詳細は[LICENSE](https://github.com/salvage0707/notion-md-converter/blob/main/LICENSE)をご覧ください。
## 作者
malvageee (https://github.com/salvage0707)