@deckflow/deckhtml
v0.3.1
Published
Convert HTML to PPTX or PNG presentations
Downloads
403
Maintainers
Readme
DeckHTML
語言: English · 简体中文 · 繁體中文 · Français · Deutsch · Español · 日本語 · 한국어
在終端機中將 HTML 檔案、標準輸入或 URL 轉換為 PPTX 或 PNG 簡報。
快速開始
無需安裝,直接執行:
npx -y @deckflow/deckhtml@latest index.html -o deck.pptx安裝
npm install -g @deckflow/deckhtml
deckhtml --version轉換 HTML
轉換單一 HTML 檔案(預設輸出至同路徑、同名檔案):
deckhtml index.html
# → index.pptx指定輸出路徑:
deckhtml index.html -o deck.pptx從標準輸入讀取 HTML:
cat index.html | deckhtml - -o deck.pptx依序轉換多個 HTML 檔案:
deckhtml page1.html page2.html page3.html -o deck.pptx轉換託管頁面:
deckhtml https://example.com/deck.html -o deck.pptx輸出格式
| 格式 | 說明 |
| --- | --- |
| pptx | PowerPoint 簡報(預設) |
| png | PNG 影格輸出 |
deckhtml index.html --format png -o frames執行模式
| 模式 | 說明 |
| --- | --- |
| auto | 已設定 API Key 時使用雲端,否則本地執行 |
| local | 始終本地執行(無需 API Key) |
| cloud | 始終雲端執行(需要 API Key) |
deckhtml index.html --mode local
deckhtml index.html --mode cloud -o deck.pptx僅雲端可用功能
以下選項需要雲端模式:
| 選項 | 說明 |
| --- | --- |
| --rebuild-svg | 重建 SVG 物件 |
| --rebuild-chart | 重建圖表物件 |
| --embed-fonts | 嵌入字型 |
| --map-motion | 對應動畫 |
deckhtml index.html \
-o deck.pptx \
--mode cloud \
--rebuild-svg \
--rebuild-chart \
--embed-fonts \
--map-motion驗證與設定
僅雲端執行和雲端專屬功能需要驗證。本地轉換無需 API Key。
deckhtml auth login
deckhtml auth status
deckhtml config set api-key <key>在 CI、Docker 或 Agent 環境中,可使用環境變數(優先於本地儲存的憑證):
export DECKHTML_API_KEY=your-api-key持久化設定:
| 命令 | 說明 | 預設值 |
| --- | --- | --- |
| deckhtml config set api-key <key> | 雲端請求使用的 API Key | — |
| deckhtml config set size <size> | PPTX 尺寸 | 1920x1080 |
| deckhtml config set webhook <url> | 預設回呼 URL | — |
| deckhtml config set retention-hours <n> | 雲端檔案保留時間(小時) | 3 |
憑證儲存在本地 ~/.deckflow/credentials。
CLI 參考
轉換選項
| 選項 | 說明 | 預設值 |
| --- | --- | --- |
| -h, --help | 顯示說明 | — |
| --version | 顯示版本 | — |
| -o, --output <path> | 輸出路徑 | 與輸入同名同路徑 |
| -v, --verbose | 詳細日誌輸出至 stderr | false |
| --quiet | 僅輸出錯誤和最終結果 | false |
| --json | stdout 輸出機器可讀 JSON | false |
| --report | 產生轉換報告 | 關閉 |
| --mode <mode> | auto、local 或 cloud | auto |
| --render-wait <seconds> | 每頁擷取前等待秒數 | 3 |
| --format <format> | pptx 或 png | pptx |
| --webhook <url> | 雲端回呼 URL | 設定項 |
| --retention-hours <n> | 雲端檔案保留時間(小時) | 設定項 |
--quiet 與 --verbose 不能同時使用。
JSON 輸出
deckhtml index.html -o deck.pptx --json{
"ok": true,
"input": ["index.html"],
"output": "deck.pptx",
"format": "pptx",
"mode": "local"
}程式 API
在 Node.js 中作為函式庫使用:
import { convertHtmlToPptx } from '@deckflow/deckhtml';
const result = await convertHtmlToPptx({
input: 'index.html',
output: 'deck.pptx',
});文件
詳細 CLI 文件見 docs/cli/ 目錄。
授權
MIT
