Skip to content

Commit 85c04f6

Browse files
committed
chore: READMEの修正
1 parent ce3359b commit 85c04f6

File tree

1 file changed

+23
-22
lines changed

1 file changed

+23
-22
lines changed

README.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,47 @@
1-
# scrapbox-duplicator
1+
# Scrapbox Duplicator
22

33
Scrapboxの非公開・公開プロジェクトを分けて運用する際に面倒な「ページの転送」を自動で行います。
44

5+
## 目次
6+
7+
- [仕組み](#仕組み)
8+
- [スタートガイド](#スタートガイド)
9+
- [必要なもの](#必要なもの)
10+
- [注意事項](#注意事項)
11+
- [その他](#その他)
12+
- [謝辞](#謝辞)
13+
514
## 仕組み
615

716
以下の処理の定期実行によって、公開したいページのみ転送されたミラープロジェクトが作られます。
817

9-
- 転送元プロジェクトの内容をエクスポート
10-
- エクスポートされたjsonファイルから`[public.icon]`が含まれているページのみを抽出
11-
- 抽出されたページを転送先プロジェクトへインポート
18+
1. 転送元プロジェクトの内容をエクスポート
19+
2. エクスポートされたjsonファイルから`[public.icon]`が含まれているページのみを抽出
20+
3. 抽出されたページを転送先プロジェクトへインポート
1221

1322
## スタートガイド
1423

15-
以下の2ステップで実行可能です。
16-
17-
1. 下のボタン('Deploy to Heroku')を押し、必要な情報を入力。
18-
2. Heroku
19-
Schedulerで`deno run --allow-net=scrapbox.io --allow-read=./ --allow-env index.ts`を定期実行するように設定
24+
以下のステップで実行可能です。
2025

21-
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://dashboard.heroku.com/new?template=https%3A%2F%2Fgithub.com%2Fblu3mo%2Fscrapbox-duplicator%2Ftree%2Fmaster)
26+
1. このリポジトリをForkする
27+
2. Forkしたリポジトリに環境変数を設定する
2228

23-
### 必要なもの
29+
## 必要なもの
2430

25-
1. `SID` ScrapboxのSID(詳しくは
26-
[こちら](https://scrapbox.io/nishio/Scrapbox%E3%81%AEprivate%E3%83%97%E3%83%AD%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88%E3%81%AEAPI%E3%82%92%E5%8F%A9%E3%81%8F)
27-
31+
1. `SID` ScrapboxのSID(詳しくは[こちら](https://scrapbox.io/nishio/Scrapbox%E3%81%AEprivate%E3%83%97%E3%83%AD%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88%E3%81%AEAPI%E3%82%92%E5%8F%A9%E3%81%8F)
2832
2. `SOURCE_PROJECT_NAME` 転送元のプロジェクト名
2933
3. `DESTINATION_PROJECT_NAME` 転送先のプロジェクト名
3034

31-
### 注意事項
35+
## 注意事項
3236

33-
- まともにテストしていないので、**自己責任で使用してください**。使用前にプロジェクトのバックアップ取得をお勧めします。
34-
- SIDは漏れた場合にリセットする手段が無さそうなので、気をつけて扱ってください。サブアカウントのSID等を使用する事をお勧めします。(詳しくは
35-
[こちら](https://scrapbox.io/nishio/Scrapbox%E3%81%AEprivate%E3%83%97%E3%83%AD%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88%E3%81%AEAPI%E3%82%92%E5%8F%A9%E3%81%8F)
36-
37+
- まともにテストしていないので、**自己責任で使用してください**。使用前にプロジェクトのバックアップ取得をオススメします。
38+
- SIDは漏れた場合にリセットする手段が無さそうなので、気をつけて扱ってください。サブアカウントのSID等を使用する事をオススメします。(詳しくは[こちら](https://scrapbox.io/nishio/Scrapbox%E3%81%AEprivate%E3%83%97%E3%83%AD%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88%E3%81%AEAPI%E3%82%92%E5%8F%A9%E3%81%8F)
3739
- export APIは使用回数に制限があるので、定期実行は一日2~3回程度が良いと思います。
3840

3941
## その他
4042

41-
- Scrapbox
42-
Duplicatorは定期実行のタイミングまで待たないと転送されません。好きなタイミングで公開したい場合は、[このUserScript](https://scrapbox.io/blu3mo-public/%E3%83%9A%E3%83%BC%E3%82%B8%E8%BB%A2%E9%80%81%E3%81%99%E3%82%8B%E6%8B%A1%E5%BC%B5script)を一緒に使う事をお勧めします。
43+
Scrapbox Duplicatorは定期実行のタイミングまで待たないと転送されません。好きなタイミングで公開したい場合は、[このUserScript](https://scrapbox.io/blu3mo-public/%E3%83%9A%E3%83%BC%E3%82%B8%E8%BB%A2%E9%80%81%E3%81%99%E3%82%8B%E6%8B%A1%E5%BC%B5script)を一緒に使う事をオススメします。
4344

4445
## 謝辞
4546

46-
- Scrapboxを開発しているNota, Inc.の皆さんに感謝します
47+
Scrapboxを開発しているNota, Inc. の皆さんに感謝します

0 commit comments

Comments
 (0)