Editable Slides CLI

文章と素材から、ブラウザで編集できるスライド、編集可能なPPTX、PDFを生成するCLIです。

初回準備

npm install --global editable-slides-cli
slide setup
slide doctor

Node.js 24以降が必要です。PDFの本文・フォント検査にはPopplerの pdftotextとpdffontsも必要です。

PopplerはOSに合わせて次のいずれかで準備できます。

| OS | コマンド | |---|---| | macOS | brew install poppler | | Ubuntu / Debian | sudo apt install poppler-utils | | Windows / 共通 | mise use -g conda:[email protected] |

導入後にslide doctorを実行し、Node.js、npm、Chromium、Popplerが すべて✓になっていることを確認してください。Xpdfの同名コマンドには対応しません。

使い方

slide new "資料名"
slide dev "資料名" --open
slide release "資料名"

組み込みテンプレートは中立なdefaultだけです。slide new -t default "資料名"と 明示することもできます。 日本語の資料名はそのままフォルダ名と表示名になり、内部IDは自動で作られます。

URLからテンプレートを追加する

信頼できるHTTPS URLのZIPを、名前を付けて登録します。

slide template add https://example.com/templates/sales.zip --name sales
slide template list
slide new -t sales "営業提案資料"

同じ名前のテンプレートを更新するときは--force、配布元が示すSHA-256と 照合するときは--sha256を指定します。

slide template add https://example.com/templates/sales.zip \
  --name sales \
  --sha256 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef \
  --force

ZIPのルート、またはZIP内の単一フォルダには、template.jsonとdeck.mdxが 必要です。layout.overrides.json、assets/、data/、README.mdも含められます。 template.jsonは次の形式です。

{
  "schemaVersion": 1,
  "id": "sales",
  "name": "営業提案テンプレート",
  "version": "1.0.0",
  "entry": "deck.mdx",
  "theme": "default"
}

独自デザインが必要な場合は、実行コードではないtheme.jsonをZIPへ含め、 template.jsonのthemeを./theme.jsonにします。CLIは登録時にテーマ定義と デッキを検証します。JavaScriptのテーマはURLテンプレートに含められません。

deck.mdxの表紙など、本文へ資料名を入れる位置には __EDITABLE_SLIDES_TITLE__と書いておきます。新規作成時に安全な資料名へ 置き換わります。先頭設定のid、title、themeは自動で設定されます。

通常はHTTPSだけを使用します。手元の開発サーバーを除くHTTP URLを使う必要が ある場合だけ--allow-httpを明示します。登録したテンプレートはOS標準の データ保存先に置かれ、EDITABLE_SLIDES_DATA_HOMEで保存先を変更できます。

不要になったテンプレートは登録名で削除します。すでに作った資料には影響しません。

slide template remove sales

旧形式の資料はslide migrate <folder>で単一ファイル形式へ移行できます。 元のファイルは削除・変更しません。 Studioの位置調整を元の資料へ反映する場合はslide layout bake <folder>を使います。 ページ・要素IDを変更する場合はslide id rename <folder> --helpを確認してください。

コマンド一覧はslide --help、各コマンドの詳細は slide <command> --helpで確認できます。

初回公開前の候補版は、GitHub Actionsのartifactまたはnpm packで作った .tgzからも試せます。ライセンスはMITです。