Maki commited on
Commit
bd78dda
1 Parent(s): 61d6484

[docs] READMEの更新とデモ画像の追加

Browse files

## 概要

- READMEにデモアプリのセクションを追加
- デモアプリのスクリーンショットを追加
- 開発用のコマンドを追加

## 詳細

### READMEの更新

- デモアプリのセクションを追加
- Hugging Face Spacesのバッジを追加
- デモアプリのスクリーンショットを追加
- サンプルのMarkdownファイルとスライド画像へのリンクを追加
- 開発用のコマンドを追加
- slidevコンテナにアクセスするコマンド
- スライドを画像としてエクスポートするコマンド

### デモ画像の追加

- `docs/demo_image.png`を追加
- デモアプリのスクリーンショット画像

Files changed (2) hide show
  1. README.md +20 -0
  2. docs/demo_image.png +3 -0
README.md CHANGED
@@ -50,6 +50,12 @@ Streamlitを使用した直感的なユーザーインターフェイスで、Ma
50
  - 🐳 Dockerによる環境構築の簡易化
51
  - 🖥️ Streamlitによる使いやすいWebUI
52
 
 
 
 
 
 
 
53
  ## 📦 インストール
54
 
55
  SlideNovaを使用するには、DockerとDocker Composeが必要です。以下の手順に従ってください。
@@ -80,8 +86,22 @@ docker-compose up --build
80
  2. 「Generate Slides」ボタンをクリックします。
81
  3. 生成されたスライドが表示されます。
82
 
 
 
 
 
 
 
 
 
 
83
  ## Develop command
84
 
 
 
 
 
 
85
  ```bash
86
  yes | npx slidev export slides/demo.md --format png --output slides/out/ --dark
87
  ```
 
50
  - 🐳 Dockerによる環境構築の簡易化
51
  - 🖥️ Streamlitによる使いやすいWebUI
52
 
53
+ ## デモアプリ
54
+
55
+ [![Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/Sunwood-ai-labs/SlideNova)
56
+
57
+ ![alt text](docs/demo_image.png)
58
+
59
  ## 📦 インストール
60
 
61
  SlideNovaを使用するには、DockerとDocker Composeが必要です。以下の手順に従ってください。
 
86
  2. 「Generate Slides」ボタンをクリックします。
87
  3. 生成されたスライドが表示されます。
88
 
89
+
90
+ ### example
91
+
92
+ example markdown file
93
+ [`slides/demo.md`](slides/demo.md)
94
+
95
+ example slide image
96
+ [`slides/sample`](slides/sample)
97
+
98
  ## Develop command
99
 
100
+
101
+ ```bash
102
+ docker-compose exec slidev /bin/bash
103
+ ```
104
+
105
  ```bash
106
  yes | npx slidev export slides/demo.md --format png --output slides/out/ --dark
107
  ```
docs/demo_image.png ADDED

Git LFS Details

  • SHA256: 7d443c1e8a14b71676b4cde56a68a7e1482440f697d828fc212877cc7bd02c4f
  • Pointer size: 131 Bytes
  • Size of remote file: 162 kB