Maki
commited on
Commit
•
58b5366
1
Parent(s):
bd78dda
[docs] README.mdとdocs/SlideNova.mdの更新
Browse filesREADME.mdとdocs/SlideNova.mdを更新し、以下の内容を追加・修正しました。
README.md:
- SlideNovaの概要を生成AIとの連携に重点を置いた内容に更新
- 主な特徴にスライドのダウンロード機能を追加
- はじめに、使い方、ドキュメント、コントリビューション、お問い合わせのセクションを見直し、内容を充実化
docs/SlideNova.md:
- SlideNovaについての詳細な説明を新たに追加
- 生成AIとの連携によるスライド作成の革新
- 構造化データを活用した効率的なスライド作成
- 開発者の時間削減と高品質なスライド作成
- 直感的なユーザーインターフェイスとアイデアへの集中
- 生成AIとの協働による新しいプレゼンテーション作成の時代
これらの変更により、SlideNovaのコンセプトと特徴がより明確になり、ユーザーにとって理解しやすくなりました。生成AIとの連携を前面に押し出すことで、SlideNovaの独自性と革新性を強調しています。
- README.md +29 -45
- docs/SlideNova.md +22 -0
README.md
CHANGED
@@ -29,9 +29,7 @@ app_port: 8501
|
|
29 |
|
30 |
## 🚀 はじめに
|
31 |
|
32 |
-
SlideNova
|
33 |
-
[Slidev](https://sli.dev/)を使用しており、スライドの生成はDockerコンテナ内で行われます。
|
34 |
-
Streamlitを使用した直感的なユーザーインターフェイスで、Markdownを入力するだけですぐにスライドを作成できます。
|
35 |
|
36 |
## 更新情報
|
37 |
|
@@ -43,76 +41,60 @@ Streamlitを使用した直感的なユーザーインターフェイスで、Ma
|
|
43 |
- ドキュメントの拡充
|
44 |
- 開発環境の整備とGitHub Actionsの設定
|
45 |
|
46 |
-
##
|
47 |
|
48 |
-
- 📝 Markdown
|
49 |
-
- 🎨 Slidev
|
50 |
-
- 🐳 Docker
|
51 |
-
- 🖥️ Streamlit
|
|
|
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が必要です。以下の手順に従ってください。
|
62 |
|
63 |
1. このリポジトリをクローンします。
|
64 |
|
65 |
-
```bash
|
66 |
-
git clone https://github.com/Sunwood-ai-labs/SlideNova.git
|
67 |
-
```
|
68 |
|
69 |
2. プロジェクトディレクトリに移動します。
|
70 |
|
71 |
-
```bash
|
72 |
-
cd SlideNova
|
73 |
-
```
|
74 |
|
75 |
3. Docker Composeを使用してSlideNovaを起動します。
|
76 |
|
77 |
-
```bash
|
78 |
-
docker-compose up --build
|
79 |
-
```
|
80 |
|
81 |
4. ブラウザで `http://localhost:8502` を開きます。
|
82 |
|
83 |
## 🛠️ 使い方
|
84 |
|
85 |
-
1. Markdownエディタにスライドのコンテンツを入力します。
|
86 |
-
2. 「Generate Slides」ボタンをクリックします。
|
87 |
-
3. 生成されたスライドが表示されます。
|
88 |
|
|
|
89 |
|
90 |
-
|
91 |
|
92 |
-
|
93 |
-
[`slides/demo.md`](slides/demo.md)
|
94 |
|
95 |
-
|
96 |
-
[`slides/sample`](slides/sample)
|
97 |
|
98 |
-
|
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 |
-
```
|
108 |
|
109 |
## 📖 ドキュメント
|
110 |
|
111 |
-
|
112 |
|
113 |
## 🤝 コントリビューション
|
114 |
|
115 |
-
|
116 |
|
117 |
## 📜 ライセンス
|
118 |
|
@@ -120,4 +102,6 @@ yes | npx slidev export slides/demo.md --format png --output slides/out/ --dark
|
|
120 |
|
121 |
## 📧 お問い合わせ
|
122 |
|
123 |
-
ご質問やご提案がありましたら、[Issue](https://github.com/Sunwood-ai-labs/SlideNova/issues)
|
|
|
|
|
|
29 |
|
30 |
## 🚀 はじめに
|
31 |
|
32 |
+
[SlideNova](docs\SlideNova.md)は、生成AIを活用することを前提とした革新的なMarkdownベースのスライド作成Webアプリケーションです。生成AIとの連携により、効率的かつ高品質なスライド作成を実現します。
|
|
|
|
|
33 |
|
34 |
## 更新情報
|
35 |
|
|
|
41 |
- ドキュメントの拡充
|
42 |
- 開発環境の整備とGitHub Actionsの設定
|
43 |
|
44 |
+
## ✨ 主な特徴
|
45 |
|
46 |
+
- 📝 **Markdownでのスライド作成**: Markdownの簡潔で直感的な記法を使ってスライドのコンテンツを作成できます。
|
47 |
+
- 🎨 **モダンなスライドデザイン**: Slidevを使用することで、洗練されたデザインのスライドを生成できます。
|
48 |
+
- 🐳 **Dockerによる環境構築の簡易化**: Dockerを活用し、複雑な環境設定なしですぐに使い始められます。
|
49 |
+
- 🖥️ **使いやすいWebUI**: Streamlitを採用した直感的なWebインターフェイスで、スムーズなスライド作成が可能です。
|
50 |
+
- 💾 **スライドのダウンロード**: 作成したスライドをPDFまたは画像形式でダウンロードできます。
|
51 |
|
52 |
+
## 🚀 はじめに
|
|
|
|
|
|
|
|
|
|
|
|
|
53 |
|
54 |
SlideNovaを使用するには、DockerとDocker Composeが必要です。以下の手順に従ってください。
|
55 |
|
56 |
1. このリポジトリをクローンします。
|
57 |
|
58 |
+
```bash
|
59 |
+
git clone https://github.com/Sunwood-ai-labs/SlideNova.git
|
60 |
+
```
|
61 |
|
62 |
2. プロジェクトディレクトリに移動します。
|
63 |
|
64 |
+
```bash
|
65 |
+
cd SlideNova
|
66 |
+
```
|
67 |
|
68 |
3. Docker Composeを使用してSlideNovaを起動します。
|
69 |
|
70 |
+
```bash
|
71 |
+
docker-compose up --build
|
72 |
+
```
|
73 |
|
74 |
4. ブラウザで `http://localhost:8502` を開きます。
|
75 |
|
76 |
## 🛠️ 使い方
|
77 |
|
78 |
+
1. Markdownエディタにスライドのコンテンツを入力します。Markdownの記法に従って、見出し、箇条書き、画像、コードブロックなどを使用してスライドを構成します。
|
|
|
|
|
79 |
|
80 |
+
2. 「Generate Slides」ボタンをクリックすると、入力したMarkdownに基づいてスライドが生成されます。
|
81 |
|
82 |
+
3. 生成されたスライドが表示されます。スライドのデザインやレイアウトは自動的に最適化されます。
|
83 |
|
84 |
+
4. 必要に応じて、スライドをPDFまたは画像形式でダウンロードすることができます。
|
|
|
85 |
|
86 |
+
### 使用例
|
|
|
87 |
|
88 |
+
- サンプルのMarkdownファイル: [`slides/demo.md`](slides/demo.md)
|
89 |
+
- サンプルのスライド画像: [`slides/sample`](slides/sample)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
90 |
|
91 |
## 📖 ドキュメント
|
92 |
|
93 |
+
より詳細な情報や[SlideNova](docs\SlideNova.md)の機能については、[ドキュメント](docs\SlideNova.md)を参照してください。
|
94 |
|
95 |
## 🤝 コントリビューション
|
96 |
|
97 |
+
SlideNovaはオープンソースプロジェクトであり、コミュニティからのコントリビューションを歓迎しています。バグ報告、機能リクエスト、プルリクエストなどを通じて、SlideNovaの改善にご協力ください。詳細は[コントリビューションガイド](CONTRIBUTING.md)を参照してください。
|
98 |
|
99 |
## 📜 ライセンス
|
100 |
|
|
|
102 |
|
103 |
## 📧 お問い合わせ
|
104 |
|
105 |
+
ご質問やご提案がありましたら、[Issue](https://github.com/Sunwood-ai-labs/SlideNova/issues)を作成してください。フィードバックは常に歓迎です!
|
106 |
+
|
107 |
+
プレゼンテーションの未来を切り拓く SlideNova で、あなたのアイデアに命を吹き込みましょう!✨
|
docs/SlideNova.md
ADDED
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
|
2 |
+
## 🌟 SlideNovaとは
|
3 |
+
|
4 |
+
### 生成AIとの連携によるスライド作成の革新
|
5 |
+
|
6 |
+
SlideNovaは、**生成AIとの連携**を前提とした革新的な**Markdownベースのスライド作成Webアプリケーション**です。近年の生成AIの発展に着目し、その力を活用することで、プレゼンテーション作成における課題を解決します。
|
7 |
+
|
8 |
+
### 構造化データを活用した効率的なスライド作成
|
9 |
+
|
10 |
+
SlideNovaでは、ユーザーは生成AIを利用してSlidev形式のMarkdownファイルを作成できます。これにより、ユーザーにとって読みやすく修正しやすいだけでなく、AIにも認識しやすい構造化データを活用することができます。
|
11 |
+
|
12 |
+
### 開発者の時間削減と高品質なスライド作成
|
13 |
+
|
14 |
+
この独自のアプローチにより、開発者は煩雑な情報展開に費やす時間を大幅に削減できます。同時に、作成されたスライドは可読性が高く、情報を効果的に伝えることができます。
|
15 |
+
|
16 |
+
### 直感的なユーザーインターフェイスとアイデアへの集中
|
17 |
+
|
18 |
+
SlideNovaは、生成AIの力を借りて、プレゼンテーション作成のプロセスを劇的に改善します。直感的なユーザーインターフェイスと強力な機能を組み合わせることで、ユーザーはアイデアに集中でき、より印象的なプレゼンテーションを作成できるようになります。
|
19 |
+
|
20 |
+
### 生成AIとの協働による新しいプレゼンテーション作成の時代
|
21 |
+
|
22 |
+
SlideNovaで、プレゼンテーション作成の新しい時代を体験してください。生成AIとの協働により、これまでにない効率性と創造性を実現します。
|