Maki commited on
Commit
4f684b1
2 Parent(s): 6d7b8eb c029685

Merge branch 'release/0.6.0'

Browse files
Files changed (3) hide show
  1. README.md +41 -29
  2. docs/SlideNova.md +22 -0
  3. docs/demo_image.png +3 -0
README.md CHANGED
@@ -29,12 +29,18 @@ app_port: 8501
29
 
30
  ## 🚀 はじめに
31
 
32
- SlideNovaは、Markdownからモダンで美しいスライドを簡単に作成できるWebアプリケーションです。
33
- [Slidev](https://sli.dev/)を使用しており、スライドの生成はDockerコンテナ内で行われます。
34
- Streamlitを使用した直感的なユーザーインターフェイスで、Markdownを入力するだけですぐにスライドを作成できます。
35
 
36
  ## 更新情報
37
 
 
 
 
 
 
 
 
 
38
  ### [2024/04/13] SlideNova v0.1.0 [リリースノート](https://github.com/Sunwood-ai-labs/SlideNova/releases/tag/v0.1.0)
39
  - Markdownからスライド生成するWebアプリの公開
40
  - Dockerを使った環境構築の自動化
@@ -42,57 +48,61 @@ Streamlitを使用した直感的なユーザーインターフェイスで、Ma
42
  - スライドのダウンロード機能
43
  - ドキュメントの拡充
44
  - 開発環境の整備とGitHub Actionsの設定
 
 
45
 
46
- ## 🌟 主な特徴
47
-
48
- - 📝 Markdownでスライド作成
49
- - 🎨 Slidevを使用したモダンなスライドデザイン
50
- - 🐳 Dockerによる環境構築の簡易化
51
- - 🖥️ Streamlitによる使いやすいWebUI
52
 
53
- ## 📦 インストール
54
 
55
  SlideNovaを使用するには、DockerとDocker Composeが必要です。以下の手順に従ってください。
56
 
57
  1. このリポジトリをクローンします。
58
 
59
- ```bash
60
- git clone https://github.com/Sunwood-ai-labs/SlideNova.git
61
- ```
62
 
63
  2. プロジェクトディレクトリに移動します。
64
 
65
- ```bash
66
- cd SlideNova
67
- ```
68
 
69
  3. Docker Composeを使用してSlideNovaを起動します。
70
 
71
- ```bash
72
- docker-compose up --build
73
- ```
74
 
75
  4. ブラウザで `http://localhost:8502` を開きます。
76
 
77
  ## 🛠️ 使い方
78
 
79
- 1. Markdownエディタにスライドのコンテンツを入力します。
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
- ```
 
 
 
88
 
89
  ## 📖 ドキュメント
90
 
91
- より詳細な情報は、[ドキュメント](docs/)を参照してください。
92
 
93
  ## 🤝 コントリビューション
94
 
95
- コントリビューションは歓迎します!詳細は[コントリビューションガイド](CONTRIBUTING.md)を参照してください。
96
 
97
  ## 📜 ライセンス
98
 
@@ -100,4 +110,6 @@ yes | npx slidev export slides/demo.md --format png --output slides/out/ --dark
100
 
101
  ## 📧 お問い合わせ
102
 
103
- ご質問やご提案がありましたら、[Issue](https://github.com/Sunwood-ai-labs/SlideNova/issues)を作成してください。
 
 
 
29
 
30
  ## 🚀 はじめに
31
 
32
+ [SlideNova](https://github.com/Sunwood-ai-labs/SlideNova/blob/develop/docs/SlideNova.md)は、生成AIを活用することを前提とした革新的なMarkdownベースのスライド作成Webアプリケーションです。生成AIとの連携により、効率的かつ高品質なスライド作成を実現します。
 
 
33
 
34
  ## 更新情報
35
 
36
+ ### [2024/04/14] SlideNova v0.6.0 [リリースノート](https://github.com/Sunwood-ai-labs/SlideNova/releases/tag/v0.6.0)
37
+ - [Hugging Face Spacesでのアプリ公開](https://huggingface.co/spaces/MakiAi/SlideNova)
38
+ - スライドのダウンロード機能の改善
39
+ - ユーザーインターフェイスの改善
40
+ - ドキュメントの拡充とリンクの最適化
41
+ - 開発環境の改善とGitHub Actionsの設定
42
+ - プロジェクトアイコンの追加とREADMEの見た目の向上
43
+
44
  ### [2024/04/13] SlideNova v0.1.0 [リリースノート](https://github.com/Sunwood-ai-labs/SlideNova/releases/tag/v0.1.0)
45
  - Markdownからスライド生成するWebアプリの公開
46
  - Dockerを使った環境構築の自動化
 
48
  - スライドのダウンロード機能
49
  - ドキュメントの拡充
50
  - 開発環境の整備とGitHub Actionsの設定
51
+ -
52
+ ## ✨ 主な特徴
53
 
54
+ - 📝 **Markdownでのスライド作成**: Markdownの簡潔で直感的な記法を使ってスライドのコンテンツを作成できます。
55
+ - 🎨 **モダンなスライドデザイン**: Slidevを使用することで、洗練されたデザインのスライドを生成できます。
56
+ - 🐳 **Dockerによる環境構築の簡易化**: Dockerを活用し、複雑な環境設定なしですぐに使い始められます。
57
+ - 🖥️ **使いやすいWebUI**: Streamlitを採用した直感的なWebインターフェイスで、スムーズなスライド作成が可能です。
58
+ - 💾 **スライドのダウンロード**: 作成したスライドをPDFまたは画像形式でダウンロードできます。
 
59
 
60
+ ## 🚀 はじめに
61
 
62
  SlideNovaを使用するには、DockerとDocker Composeが必要です。以下の手順に従ってください。
63
 
64
  1. このリポジトリをクローンします。
65
 
66
+ ```bash
67
+ git clone https://github.com/Sunwood-ai-labs/SlideNova.git
68
+ ```
69
 
70
  2. プロジェクトディレクトリに移動します。
71
 
72
+ ```bash
73
+ cd SlideNova
74
+ ```
75
 
76
  3. Docker Composeを使用してSlideNovaを起動します。
77
 
78
+ ```bash
79
+ docker-compose up --build
80
+ ```
81
 
82
  4. ブラウザで `http://localhost:8502` を開きます。
83
 
84
  ## 🛠️ 使い方
85
 
86
+ 1. Markdownエディタにスライドのコンテンツを入力します。Markdownの記法に従って、見出し、箇条書き、画像、コードブロックなどを使用してスライドを構成します。
87
+
88
+ 2. 「Generate Slides」ボタンをクリックすると、入力したMarkdownに基づいてスライドが生成されます。
89
 
90
+ 3. 生成されたスライドが表示されます。スライドのデザインやレイアウトは自動的に最適化されます。
91
 
92
+ 4. 必要に応じて、スライドをPDFまたは画像形式でダウンロードすることができます。
93
+
94
+ ### 使用例
95
+
96
+ - サンプルのMarkdownファイル: [`slides/demo.md`](slides/demo.md)
97
+ - サンプルのスライド画像: [`slides/sample`](slides/sample)
98
 
99
  ## 📖 ドキュメント
100
 
101
+ より詳細な情報や[SlideNova]の機能については、[ドキュメント](https://github.com/Sunwood-ai-labs/SlideNova/blob/develop/docs/SlideNova.md)を参照してください。
102
 
103
  ## 🤝 コントリビューション
104
 
105
+ SlideNovaはオープンソースプロジェクトであり、コミュニティからのコントリビューションを歓迎しています。バグ報告、機能リクエスト、プルリクエストなどを通じて、SlideNovaの改善にご協力ください。詳細は[コントリビューションガイド](CONTRIBUTING.md)を参照してください。
106
 
107
  ## 📜 ライセンス
108
 
 
110
 
111
  ## 📧 お問い合わせ
112
 
113
+ ご質問やご提案がありましたら、[Issue](https://github.com/Sunwood-ai-labs/SlideNova/issues)を作成してください。フィードバックは常に歓迎です!
114
+
115
+ プレゼンテーションの未来を切り拓く 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との協働により、これまでにない効率性と創造性を実現します。
docs/demo_image.png ADDED

Git LFS Details

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