HovercraftAPI

～ Craft your story, let HovercraftAPI do the rest ～

[🌐 Website] • [🐱 GitHub] [🐦 Twitter] • [🍀 Official Blog]

[!IMPORTANT] このリポジトリのリリースノートやREADME、コミットメッセージの9割近くはclaude.aiやChatGPT4を活用したAIRA, SourceSage, Gaiah, HarmonAI_IIで生成しています。

🌟 HovercraftAPI

HovercraftAPIは、Markdownファイルから印象的なHovercraftプレゼンテーションを簡単に作成するためのPythonツールです。Mermaidダイアグラムやコードブロックのサポート、カスタムCSSによるスタイリング、動的な3Dトランジション、SVG変換など、多彩な機能を提供します。

🎥 デモ

https://github.com/user-attachments/assets/670f8b37-88eb-4f8e-9bbe-2bf9f7797d5e

🚀 はじめに

インストール

pip install hovercraft-api

📝 HovercraftAPIの使い方

コマンドラインインターフェース

基本的な使用方法:

hovercraftapi example/README.md -c css/mytheme.css

3Dダイナミックトランジションを有効にする場合:

hovercraft-api example3/README.md -c css/mytheme.css --enable-dynamic-position

カスタムCSSの使用

poetry run hovercraft-api example3/README.md -c css/oasis.css --enable-dynamic-position 
poetry run hovercraft-api example3/README.md -c css/Deepsea_and_Rust.css --enable-dynamic-position --svg-css-file css/svg_oasis.css

Pythonスクリプト内での使用

from hovercraft_api import HovercraftAPI

api = HovercraftAPI("your_markdown_file.md", css_file="path/to/your/custom.css", enable_dynamic_position=True)
api.generate_slides()

特徴

• Markdownからスライドを生成
• Mermaidダイアグラムとコードブロックをサポート
• カスタムCSSによるスタイリング
• CLIインターフェース対応
• スライドのキャプチャと動画生成機能
• 動的なスライド位置決め機能
• MermaidダイアグラムのSVG変換とアニメーション
• ローカルMermaid SVGプレビューサーバー

必要条件

• Python 3.10以上
• Poetry（依存関係管理に使用）
• その他の依存関係は pyproject.toml を参照してください。

プロジェクト構造

HovercraftAPI/
├─ css/
│  ├─ mytheme.css
│  ├─ flowchart1.css
├─ docs/
│  ├─ usage.md
├─ example/
│  ├─ README.md
│  ├─ sample.py
├─ hovercraft_api/
│  ├─ code_block_alchemist.py
│  ├─ dynamic_rst_adjuster.py
│  ├─ HovercraftAPI.py
│  ├─ hovercraft_converter.py
│  ├─ markdown_to_rst_converter.py
│  ├─ markdown_to_slides_converter.py
│  ├─ mermaid_alchemist.py
│  ├─ mermaid_server.py
│  ├─ mermaid_svg_converter.py
│  ├─ rst_adjuster.py
│  ├─ slide_capturer.py
│  ├─ svg_animator.py
│  ├─ utils.py
│  ├─ __init__.py
├─ pyproject.toml
├─ README.md

🛠️ 開発

このプロジェクトはPoetryを使用して依存関係を管理しています。開発環境のセットアップは以下のコマンドで行えます：

poetry install

3Dダイナミックトランジションを有効にしてHovercraftAPIを実行:

poetry run hovercraft-api example2\README.md  --enable-dynamic-position

ローカルMermaid SVGプレビューサーバーを起動:

poetry run python hovercraft_api\mermaid_server.py

MermaidダイアグラムをSVGに変換:

poetry run python hovercraft_api\mermaid_svg_converter.py

スライドのキャプチャと動画生成:

poetry run hovercraft-api example2\README.md --stages capture_slides --capture-images --capture-video

🤝 貢献

プルリクエストは大歓迎です。大きな変更の場合は、まずissueを開いて議論してください。

🙏 サポート

問題が発生した場合は、GitHubのissueを開いてください。

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。詳細は LICENSE ファイルを参照してください。