|
1 |
| -# scrapbox-duplicator |
| 1 | +# Scrapbox Duplicator |
2 | 2 |
|
3 | 3 | Scrapboxの非公開・公開プロジェクトを分けて運用する際に面倒な「ページの転送」を自動で行います。
|
4 | 4 |
|
| 5 | +## 目次 |
| 6 | + |
| 7 | +- [仕組み](#仕組み) |
| 8 | +- [スタートガイド](#スタートガイド) |
| 9 | +- [必要なもの](#必要なもの) |
| 10 | +- [注意事項](#注意事項) |
| 11 | +- [その他](#その他) |
| 12 | +- [謝辞](#謝辞) |
| 13 | + |
5 | 14 | ## 仕組み
|
6 | 15 |
|
7 | 16 | 以下の処理の定期実行によって、公開したいページのみ転送されたミラープロジェクトが作られます。
|
8 | 17 |
|
9 |
| -- 転送元プロジェクトの内容をエクスポート |
10 |
| -- エクスポートされたjsonファイルから`[public.icon]`が含まれているページのみを抽出 |
11 |
| -- 抽出されたページを転送先プロジェクトへインポート |
| 18 | +1. 転送元プロジェクトの内容をエクスポート |
| 19 | +2. エクスポートされたjsonファイルから`[public.icon]`が含まれているページのみを抽出 |
| 20 | +3. 抽出されたページを転送先プロジェクトへインポート |
12 | 21 |
|
13 | 22 | ## スタートガイド
|
14 | 23 |
|
15 |
| -以下の2ステップで実行可能です。 |
| 24 | +以下のステップで実行可能です。 |
| 25 | + |
| 26 | +1. このリポジトリをForkする |
| 27 | +2. Forkしたリポジトリに環境変数を設定する |
| 28 | + |
| 29 | +<!-- 環境変数の設定イメージ --> |
| 30 | +以下の画像は環境変数の設定方法を示しています。 |
| 31 | +[](https://gyazo.com/cd8630a6fb125c6d7e627b290fbe79ce) |
16 | 32 |
|
17 |
| -1. 下のボタン('Deploy to Heroku')を押し、必要な情報を入力。 |
18 |
| -2. Heroku |
19 |
| - Schedulerで`deno run --allow-net=scrapbox.io --allow-read=./ --allow-env index.ts`を定期実行するように設定 |
| 33 | +<!-- すぐに動作確認がしたい時は手動で起動できる --> |
| 34 | +動作確認をすぐに行いたい場合は、以下の画像のように手動で起動することが可能です。 |
| 35 | +[](https://gyazo.com/e4762cda8e8566bb75d20a429c2f1cb1) |
20 | 36 |
|
21 |
| -[](https://dashboard.heroku.com/new?template=https%3A%2F%2Fgithub.com%2Fblu3mo%2Fscrapbox-duplicator%2Ftree%2Fmaster) |
22 | 37 |
|
23 |
| -### 必要なもの |
| 38 | +## 必要なもの |
24 | 39 |
|
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 |
| - ) |
| 40 | +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)) |
28 | 41 | 2. `SOURCE_PROJECT_NAME` 転送元のプロジェクト名
|
29 | 42 | 3. `DESTINATION_PROJECT_NAME` 転送先のプロジェクト名
|
30 | 43 |
|
31 |
| -### 注意事項 |
| 44 | +## 注意事項 |
32 | 45 |
|
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 |
| - ) |
| 46 | +- まともにテストしていないので、**自己責任で使用してください**。使用前にプロジェクトのバックアップ取得をオススメします。 |
| 47 | +- 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)) |
37 | 48 | - export APIは使用回数に制限があるので、定期実行は一日2~3回程度が良いと思います。
|
38 | 49 |
|
39 | 50 | ## その他
|
40 | 51 |
|
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)を一緒に使う事をお勧めします。 |
| 52 | +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)を一緒に使う事をオススメします。 |
43 | 53 |
|
44 | 54 | ## 謝辞
|
45 | 55 |
|
46 |
| -- Scrapboxを開発しているNota, Inc.の皆さんに感謝します |
| 56 | +Scrapboxを開発しているNota, Inc. の皆さんに感謝します。 |
0 commit comments