zengen 0.2.1 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. package/.github/workflows/pages.yml +7 -4
  2. package/.zen/meta.json +40 -118
  3. package/.zen/src/ar-SA/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  4. package/.zen/src/da-DK/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  5. package/.zen/src/de-DE/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  6. package/.zen/src/de-DE/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  7. package/.zen/src/de-DE/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  8. package/.zen/src/en-US/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  9. package/.zen/src/en-US/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  10. package/.zen/src/en-US/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  11. package/.zen/src/en-US/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md +63 -0
  12. package/.zen/src/es-ES/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  13. package/.zen/src/es-ES/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  14. package/.zen/src/es-ES/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  15. package/.zen/src/es-MX/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  16. package/.zen/src/fi-FI/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  17. package/.zen/src/fr-FR/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  18. package/.zen/src/fr-FR/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  19. package/.zen/src/fr-FR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  20. package/.zen/src/hi-IN/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  21. package/.zen/src/id-ID/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  22. package/.zen/src/it-IT/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  23. package/.zen/src/ja-JP/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +71 -0
  24. package/.zen/src/ja-JP/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  25. package/.zen/src/ja-JP/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  26. package/.zen/src/ko-KR/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  27. package/.zen/src/ko-KR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  28. package/.zen/src/nl-NL/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  29. package/.zen/src/no-NO/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  30. package/.zen/src/pl-PL/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  31. package/.zen/src/pt-BR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  32. package/.zen/src/pt-PT/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  33. package/.zen/src/pt-PT/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  34. package/.zen/src/pt-PT/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  35. package/.zen/src/ru-RU/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  36. package/.zen/src/ru-RU/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  37. package/.zen/src/ru-RU/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  38. package/.zen/src/sv-SE/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  39. package/.zen/src/th-TH/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  40. package/.zen/src/tr-TR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  41. package/.zen/src/uk-UA/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  42. package/.zen/src/vi-VN/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  43. package/.zen/src/zh-Hans/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  44. package/.zen/src/zh-Hans/084ef1f6a0167df8621c673c79211309d4af6c588e7bbe3e043f7c244edd0ac6.md +80 -0
  45. package/.zen/src/zh-Hans/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  46. package/.zen/src/zh-Hans/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  47. package/.zen/src/zh-Hans/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md +63 -0
  48. package/.zen/src/zh-Hant/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  49. package/README.md +30 -34
  50. package/assets/templates/default/layout.html +58 -3
  51. package/dist/ai/translateMarkdown.d.ts +1 -1
  52. package/dist/ai/translateMarkdown.d.ts.map +1 -1
  53. package/dist/ai/translateMarkdown.js +33 -2
  54. package/dist/ai/translateMarkdown.js.map +1 -1
  55. package/dist/languages.d.ts +2 -0
  56. package/dist/languages.d.ts.map +1 -0
  57. package/dist/languages.js +37 -0
  58. package/dist/languages.js.map +1 -0
  59. package/dist/process/template.js +11 -12
  60. package/dist/process/template.js.map +1 -1
  61. package/package.json +2 -2
  62. package/src/ai/translateMarkdown.ts +33 -2
  63. package/src/languages.ts +37 -0
  64. package/src/process/template.ts +12 -12
  65. package/docs/advanced-usage.md +0 -39
  66. package/docs/deployment/github-pages.md +0 -107
  67. package/docs/getting-started.md +0 -26
  68. package/docs/guides/best-practices.md +0 -175
  69. package/docs/guides/config.md +0 -48
  70. package/docs/guides/index.md +0 -51
  71. package/docs/testing/test-document.md +0 -1
@@ -0,0 +1,81 @@
1
+ ---
2
+ title: ZEN - Markdown ドキュメントサイト構築ツール
3
+ summary: ZENは、コンテンツファーストとミニマリズムを重視した、シンプルなMarkdown静的サイトジェネレーターです。AIを活用したインテリジェントなナビゲーションと多言語翻訳を実現し、ユーザーが複雑な設定なしに執筆に集中できるよう支援します。
4
+ tags:
5
+ - Markdown
6
+ - 静的サイト生成
7
+ - AI翻訳
8
+ - 多言語
9
+ - ミニマリズム
10
+ - ドキュメントツール
11
+ - ZEN
12
+ inferred_lang: ja-JP
13
+ ---
14
+
15
+ # ZEN - シンプルな Markdown ドキュメントサイト構築ツール
16
+
17
+ [简体中文](https://zccz14.github.io/ZEN/zh-Hans) |
18
+ [English](https://zccz14.github.io/ZEN/en-US) |
19
+ [Español](https://zccz14.github.io/ZEN/es-ES) |
20
+ [Português](https://zccz14.github.io/ZEN/pt-PT) |
21
+ [Русский](https://zccz14.github.io/ZEN/ru-RU) |
22
+ [Français](https://zccz14.github.io/ZEN/fr-FR) |
23
+ [日本語](https://zccz14.github.io/ZEN/ja-JP) |
24
+ [한국어](https://zccz14.github.io/ZEN/ko-KR) |
25
+ [Deutsch](https://zccz14.github.io/ZEN/de-DE) |
26
+
27
+ なぜまたMarkdown静的サイトジェネレーターを作ったのか?AI時代において、ドキュメントツールがどのように執筆者により良くサービスを提供できるか、私は再考しました:
28
+
29
+ - **コンテンツへの回帰:** 最小限の干渉、執筆への集中
30
+
31
+ ドキュメントを本質に戻し、執筆を静寂に戻します。
32
+
33
+ 第一に、私は図書館司書になりたくありません。時々何かを書き留めたいと思うことがありますが、タイトルをまだ考えていなかったり、特別な構成がまだできていなかったりします。LLMが自動的にタイトルを生成し、要約、分類、ナビゲーションなどの整理作業を手伝ってくれることを望んでいます。
34
+
35
+ 第二に、私の書斎はきれいに掃除されていなければなりません。複雑な設定のビルドツール、複雑なドキュメント設定の調整、複雑な構造は好みません。Docusaurus、VuePress、Astroなどのツールの設定ファイルやプロジェクト構造を見るたびに、頭が痛くなります。現在、ZENはすべての設定を`.zen`ディレクトリに隠し、隅に追いやることを選択しました。ユーザーは執筆内容に集中するだけでよく、他のことはZENが処理します。他のディレクトリはすべてあなたの執筆スペースであり、Markdownファイルを自由に整理できます。
36
+
37
+ - **母国語への回帰:** 母国語で執筆し、シームレスに多言語バージョンを構築
38
+
39
+ 人生は短い、私は翻訳するのが面倒です。人は母国語を使用するとき、自身の思考の深さを最も発揮できます。しかし同時に、世界とつながりを保つことも必要であり、多言語でのコミュニケーションを諦めたくはありません。そこで、母国語で執筆しながら、より多くの人に私のコンテンツを見てもらえるツールを望んでいました。現在のi18nは自分で翻訳するだけでなく、コンテンツの更新も自分で管理しなければならず、非常に面倒です。私はLLMを使って翻訳を手伝ってもらうことを選択し、多くの時間を節約し、ワンクリックで複数の言語への翻訳を完了できます。
40
+
41
+ ## 基本機能
42
+
43
+ 1. **静的サイト生成**
44
+ - Markdownを含む任意のフォルダを静的HTMLサイトに構築します。
45
+
46
+ 2. **インテリジェントナビゲーション**
47
+ - サイトマップとナビゲーションを生成します。元のMarkdownソースファイルのディレクトリ構造を維持する必要はなく、ソースファイルを自由に移動できます。
48
+
49
+ 3. **インクリメンタルi18n翻訳**
50
+ - LLMを使用したインクリメンタルi18n翻訳により、ユーザーは母国語でMarkdownを記述できますが、ユーザーは多言語対応になります。
51
+
52
+ ## 設計理念
53
+
54
+ - **ミニマリズム:** 最小限の設定、最大限の柔軟性
55
+ - **コンテンツファースト:** ツールの設定ではなく、執筆に集中
56
+ - **AI活用:** AIを活用した翻訳とコンテンツ整理
57
+ - **クロスランゲージ:** 多言語コンテンツの作成と表示をサポート
58
+
59
+ ## クイックスタート
60
+
61
+ ### 推奨使用方法
62
+
63
+ **ユーザーはMarkdownファイルを含むディレクトリに切り替え、以下のコマンドを直接使用して構築を開始することをお勧めします:**
64
+
65
+ ```bash
66
+ # 環境変数を設定 (実際の状況に応じて変更)
67
+ export OPENAI_API_KEY="sk-xxxxxx" # 必須:OpenAI API Keyに置き換えてください
68
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # オプション、デフォルトはOpenAI公式APIを使用
69
+ export OPENAI_MODEL="gpt-3.5-turbo" # オプション、デフォルトはgpt-3.5-turboモデルを使用
70
+
71
+ # サイトを構築し、多言語翻訳をサポート
72
+ npx zengen@latest build --lang zh-Hans --lang en-US --verbose
73
+ ```
74
+
75
+ **その他のパラメータやヘルプを表示:**
76
+
77
+ ```bash
78
+ npx zengen
79
+ ```
80
+
81
+ **注意:** ZENは現在のディレクトリをソースディレクトリとして使用し、`.zen/dist`ディレクトリに出力することを強制します。ソースディレクトリと出力ディレクトリのパラメータ指定はサポートしていません。
@@ -0,0 +1,71 @@
1
+ ---
2
+ title: ZEN - 極簡主義 Markdown + AI 静的サイトビルダー
3
+ summary: ZENはAIを統合した静的サイトジェネレーターで、インテリジェントな分類ナビゲーションと自動インクリメンタル翻訳をサポートします。ユーザーは母国語での執筆に集中でき、設定とビルドプロセスが簡素化されています。
4
+ tags:
5
+ - 静的サイトジェネレーター
6
+ - Markdown
7
+ - AI
8
+ - 多言語翻訳
9
+ - 極簡主義
10
+ - ドキュメントツール
11
+ - Node.js
12
+ inferred_lang: ja-JP
13
+ ---
14
+
15
+ # ZEN - 極簡主義 Markdown + AI 静的サイトビルダー
16
+
17
+ [> ウェブサイトデモ](https://zccz14.github.io/ZEN/)
18
+
19
+ ## 基本機能
20
+
21
+ 1. 📃 **静的サイト生成**: Markdownを含む任意のgitフォルダを静的HTMLサイトに構築します。
22
+ 2. 🧭 **インテリジェント分類ナビゲーション**: AIによるコンテンツ分析を使用して、サイトマップとナビゲーションを生成します。ソースファイルの位置に依存しません。
23
+ 3. 🌍 **自動インクリメンタル翻訳**: AIによるインクリメンタル翻訳を使用し、ユーザーは母国語でMarkdownを記述できますが、多言語のユーザーに対応可能です。
24
+
25
+ なぜまたMarkdown静的サイトジェネレーターを作ったのか?AI時代において、ドキュメントツールが書き手により良くどのように奉仕できるか、私は再考しました:
26
+
27
+ - コンテンツへの回帰: 最小限の干渉で、執筆に集中
28
+
29
+ ドキュメントを本質に戻し、執筆を静寂に戻します。
30
+
31
+ 第一に、私は図書館司書になりたくありません。時々何かを書き留めたいと思うことがありますが、そのタイトルをまだ決めていないかもしれませんし、特別な組織化ができていないかもしれません。LLMが自動的にタイトルを生成し、要約、分類、ナビゲーションなどの整理作業を手伝ってくれることを望みます。
32
+
33
+ 第二に、私の書斎はきれいに掃除されていなければなりません。複雑な設定のビルドツールや、複雑なドキュメント設定、複雑な構造をいじりたくありません。Docusaurus、VuePress、Astroといったツールの設定ファイルやプロジェクト構造を見るたびに、私は頭が痛くなります。現在、ZENはすべての設定を `.zen` ディレクトリに隠し、隅に掃き寄せることを選択しました。ユーザーは執筆コンテンツにのみ集中し、他のことはZENに任せます。他のディレクトリはすべてあなたの執筆スペースであり、Markdownファイルを自由に整理できます。
34
+
35
+ - 母国語への回帰: 母国語で執筆し、滑らかに多言語バージョンを構築
36
+
37
+ 人生は短いので、翻訳は面倒です。人は母国語を使用するとき、自身の思考の深さを最も発揮できます。しかし同時に、世界とのつながりを保つことも必要であり、多言語でのコミュニケーションを諦めたくはありません。そこで私は、母国語で執筆しながら、より多くの人々に私のコンテンツを見てもらえるツールを望みました。現在のi18nは自分で翻訳するだけでなく、コンテンツの更新も自分で管理しなければならず、非常に面倒です。私はLLMを使って翻訳を手伝ってもらうことを選択し、多くの時間を節約し、ワンクリックで多国語翻訳を完了できます。
38
+
39
+ ## クイックスタート
40
+
41
+ 前提条件:
42
+
43
+ - [Node.js](https://nodejs.org/) がインストール済み(バージョン18以上を推奨、npxコマンドが必要)
44
+ - [OpenAI API Key](https://platform.openai.com/account/api-keys) を取得済み、またはOPENAI互換のAPI Keyを取得済み
45
+ - Gitがインストール済み(GitからMarkdownファイルをリストアップし、.gitignoreルールでフィルタリングされたファイルを無視するため)
46
+
47
+ まず、既にgitで管理されているフォルダ内で作業します:
48
+
49
+ 環境変数を設定します
50
+
51
+ ```bash
52
+ export OPENAI_API_KEY="sk-xxxxxx" # 必須: ご自身のOpenAI API Keyに置き換えてください
53
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # オプション、デフォルトはOpenAI公式APIを使用
54
+ export OPENAI_MODEL="gpt-3.5-turbo" # オプション、デフォルトはgpt-3.5-turboモデルを使用
55
+ ```
56
+
57
+ サイトを構築し、多言語翻訳をサポートします。現在のディレクトリをソースディレクトリとして使用し、`.zen/dist` ディレクトリに出力します。
58
+
59
+ - `--lang` パラメータを複数回使用して、生成する言語バージョンを指定できます(例: `--lang zh-Hans --lang en-US`)。
60
+ - `--base-url` パラメータでサイトのベースURLプレフィックスを指定できます(例: GitHub Pages上のリポジトリ名)。
61
+ - ソース言語の設定は不要です。ZENが自動的に検出します。
62
+
63
+ ```bash
64
+ npx zengen@latest build --lang zh-Hans --lang en-US
65
+ ```
66
+
67
+ **その他のパラメータやヘルプを表示**:
68
+
69
+ ```bash
70
+ npx zengen@latest
71
+ ```
@@ -0,0 +1,81 @@
1
+ ---
2
+ title: ZEN - 마크다운 문서 사이트 빌드 도구
3
+ summary: ZEN은 내용 중심과 극도의 간결함을 강조하는 깔끔한 마크다운 정적 사이트 생성 도구입니다. AI를 활용한 지능형 탐색 및 다국어 번역을 통해 사용자가 복잡한 설정 없이 글쓰기에 집중할 수 있도록 돕습니다.
4
+ tags:
5
+ - Markdown
6
+ - 정적 사이트 생성
7
+ - AI 번역
8
+ - 다국어
9
+ - 미니멀리즘
10
+ - 문서 도구
11
+ - ZEN
12
+ inferred_lang: ko-KR
13
+ ---
14
+
15
+ # ZEN - 깔끔한 마크다운 문서 사이트 빌드 도구
16
+
17
+ [简体中文](https://zccz14.github.io/ZEN/zh-Hans) |
18
+ [English](https://zccz14.github.io/ZEN/en-US) |
19
+ [Español](https://zccz14.github.io/ZEN/es-ES) |
20
+ [Português](https://zccz14.github.io/ZEN/pt-PT) |
21
+ [Русский](https://zccz14.github.io/ZEN/ru-RU) |
22
+ [Français](https://zccz14.github.io/ZEN/fr-FR) |
23
+ [日本語](https://zccz14.github.io/ZEN/ja-JP) |
24
+ [한국어](https://zccz14.github.io/ZEN/ko-KR) |
25
+ [Deutsch](https://zccz14.github.io/ZEN/de-DE) |
26
+
27
+ 왜 또 다른 마크다운 정적 사이트 생성기를 만들었을까요? AI 시대에 문서 도구가 글쓰는 사람에게 어떻게 더 잘 서비스할 수 있을지 다시 생각해보았습니다:
28
+
29
+ - **내용으로의 회귀**: 최소한의 방해, 글쓰기에 집중
30
+
31
+ 문서의 본질과 글쓰기의 평온함으로 돌아갑니다.
32
+
33
+ 첫째, 저는 도서관 사서가 되고 싶지 않습니다. 때로는 내용을 적고 싶지만, 아직 제목을 정하지 못했거나 특별한 체계를 갖추지 못한 경우가 있습니다. LLM이 자동으로 제목을 생성하고, 요약하고, 분류하고, 탐색하는 등의 정리 작업을 해주길 바랍니다.
34
+
35
+ 둘째, 제 서재는 반드시 깨끗해야 합니다. 복잡한 구성 도구를 설정하거나, 복잡한 문서 구성을 꾸미는 것을 원하지 않으며, 복잡한 구조를 좋아하지 않습니다. Docusaurus, VuePress, Astro 같은 도구들의 설정 파일과 프로젝트 구조를 볼 때마다 머리가 아픕니다. 이제 ZEN은 모든 구성을 `.zen` 디렉토리 안에 숨겨 구석으로 치우기로 선택했습니다. 사용자는 글쓰기 내용에만 집중하면 되며, 나머지는 ZEN이 처리합니다. 다른 디렉토리들은 모두 여러분의 글쓰기 공간이며, 마크다운 파일을 자유롭게 구성할 수 있습니다.
36
+
37
+ - **모국어로의 회귀**: 모국어로 글쓰고, 부드러운 다국어 버전 빌드
38
+
39
+ 인생은 짧습니다. 저는 번역하기 귀찮습니다. 사람은 모국어를 사용할 때 가장 깊이 생각할 수 있습니다. 하지만 동시에 세계와 연결을 유지하는 것도 필요하며, 다국어 소통을 포기하고 싶지 않습니다. 그래서 저는 모국어로 글을 쓰면서도 더 많은 사람들이 제 내용을 볼 수 있도록 해주는 도구를 원했습니다. 현재의 i18n은 직접 번역해야 할 뿐만 아니라 내용 업데이트도 직접 관리해야 하니 너무 번거롭습니다. 저는 LLM을 사용하여 번역을 도와주도록 선택했고, 많은 시간을 절약하며 한 번의 클릭으로 여러 국가 언어 번역을 완료할 수 있습니다.
40
+
41
+ ## 기본 기능
42
+
43
+ 1. **정적 사이트 생성**
44
+ - 마크다운 파일이 포함된 임의의 폴더를 정적 HTML 사이트로 빌드합니다.
45
+
46
+ 2. **지능형 탐색**
47
+ - 사이트맵과 탐색을 생성합니다. 원본 마크다운 소스 파일의 디렉토리 구조를 유지할 필요가 없으며, 소스 파일을 자유롭게 이동할 수 있습니다.
48
+
49
+ 3. **증분 i18n 번역**
50
+ - LLM을 사용한 증분 i18n 번역으로, 사용자가 모국어로 마크다운을 작성하지만 다국어 사용자가 될 수 있도록 합니다.
51
+
52
+ ## 디자인 철학
53
+
54
+ - **미니멀리즘**: 최소한의 구성, 최대의 유연성
55
+ - **내용 우선**: 도구 구성이 아닌 글쓰기에 집중
56
+ - **AI 활용**: AI를 활용한 번역 및 내용 구성
57
+ - **다국어 지원**: 다국어 콘텐츠 제작 및 표시 지원
58
+
59
+ ## 빠른 시작
60
+
61
+ ### 권장 사용 방법
62
+
63
+ **사용자는 마크다운 파일이 포함된 디렉토리로 전환한 후, 아래 명령어를 직접 사용하여 빌드를 시작하는 것을 권장합니다:**
64
+
65
+ ```bash
66
+ # 환경 변수 설정 (실제 상황에 맞게 수정)
67
+ export OPENAI_API_KEY="sk-xxxxxx" # 필수: 귀하의 OpenAI API Key로 교체하세요
68
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # 선택 사항, 기본값은 OpenAI 공식 API 사용
69
+ export OPENAI_MODEL="gpt-3.5-turbo" # 선택 사항, 기본값은 gpt-3.5-turbo 모델 사용
70
+
71
+ # 사이트 빌드, 다국어 번역 지원
72
+ npx zengen@latest build --lang zh-Hans --lang en-US --verbose
73
+ ```
74
+
75
+ **더 많은 매개변수 또는 도움말 보기**:
76
+
77
+ ```bash
78
+ npx zengen
79
+ ```
80
+
81
+ **참고**: ZEN은 현재 디렉토리를 소스 디렉토리로 사용하고, `.zen/dist` 디렉토리에 출력하도록 강제합니다. 소스 디렉토리와 출력 디렉토리 매개변수 지정을 지원하지 않습니다.
@@ -0,0 +1,71 @@
1
+ ---
2
+ title: ZEN - 미니멀리즘 Markdown + AI 정적 사이트 빌더
3
+ summary: ZEN은 AI를 결합한 정적 사이트 생성기로, 지능형 분류 네비게이션과 자동 증분 번역을 지원하여 사용자가 모국어로 작성에 집중하고, 설정 및 빌드 과정을 단순화합니다.
4
+ tags:
5
+ - 정적 사이트 생성기
6
+ - Markdown
7
+ - AI
8
+ - 다국어 번역
9
+ - 미니멀리즘
10
+ - 문서 도구
11
+ - Node.js
12
+ inferred_lang: ko-KR
13
+ ---
14
+
15
+ # ZEN - 미니멀리즘 Markdown + AI 정적 사이트 빌더
16
+
17
+ [> 웹사이트 데모](https://zccz14.github.io/ZEN/)
18
+
19
+ ## 기본 기능
20
+
21
+ 1. 📃 **정적 사이트 생성**: Markdown 파일이 포함된 임의의 git 폴더를 정적 HTML 사이트로 빌드합니다.
22
+ 2. 🧭 **지능형 분류 네비게이션**: AI를 사용하여 콘텐츠를 분석하고, 사이트맵과 네비게이션을 생성합니다. 원본 파일의 위치에 민감하지 않습니다.
23
+ 3. 🌍 **자동 증분 번역**: AI를 사용한 증분 번역을 통해 사용자가 모국어로 Markdown을 작성하지만, 다국어 사용자가 될 수 있도록 합니다.
24
+
25
+ 왜 또 Markdown 정적 사이트 생성기를 만들었을까요? AI 시대에 문서 도구가 작가에게 어떻게 더 잘 서비스할 수 있을지 다시 생각해보았습니다:
26
+
27
+ - 콘텐츠로의 회귀: 최소한의 방해, 집중적인 작성
28
+
29
+ 문서의 본질로 돌아가고, 글쓰기의 평온함으로 돌아갑니다.
30
+
31
+ 첫째, 나는 도서관 사서가 되고 싶지 않습니다. 때로는 어떤 내용을 적고 싶지만, 아직 제목을 정하지 못했거나 특별한 체계를 형성하지 못한 경우가 있습니다. LLM이 자동으로 제목을 생성하고, 요약하고, 분류하고, 네비게이션 등 정리 작업을 해주길 바랍니다.
32
+
33
+ 둘째, 내 서재는 반드시 깨끗해야 합니다. 복잡한 구성의 빌드 도구를 설정하고, 복잡한 문서 구성을 꾸미는 것을 원하지 않으며, 복잡한 구조를 좋아하지 않습니다. Docusaurus, VuePress, Astro 같은 도구들의 설정 파일과 프로젝트 구조를 볼 때마다 두통이 옵니다. 이제 ZEN은 모든 설정을 .zen 디렉토리 안에 숨기고, 구석으로 치워버립니다. 사용자는 작성 콘텐츠에만 집중하면 되며, 나머지는 ZEN이 처리합니다. 다른 디렉토리들은 모두 여러분의 작성 공간이며, Markdown 파일을 자유롭게 구성할 수 있습니다.
34
+
35
+ - 모국어로의 회귀: 모국어로 작성하고, 부드럽게 다국어 버전 빌드
36
+
37
+ 인생은 짧습니다. 저는 번역하기가 귀찮습니다. 사람은 모국어를 사용할 때 가장 자신의 사고 깊이를 발휘할 수 있습니다. 하지만 동시에 세계와의 연결을 유지하는 것은 필수적이며, 다국어 소통을 포기하고 싶지 않습니다. 그래서 저는 모국어로 글을 쓰면서도 더 많은 사람들이 제 콘텐츠를 볼 수 있도록 해주는 도구를 원했습니다. 현재의 i18n은 직접 번역해야 할 뿐만 아니라, 콘텐츠 업데이트도 직접 관리해야 해서 너무 번거롭습니다. 저는 LLM을 사용하여 번역을 도와주도록 선택했고, 많은 시간을 절약하며, 한 번의 클릭으로 다국어 번역을 완료할 수 있습니다.
38
+
39
+ ## 빠른 시작
40
+
41
+ 필수 조건:
42
+
43
+ - [Node.js](https://nodejs.org/) 설치됨 (버전 18 이상 권장, npx 명령어 필요)
44
+ - [OpenAI API Key](https://platform.openai.com/account/api-keys) 획득, 또는 OPENAI 호환 API Key
45
+ - Git 설치됨 (Git에서 Markdown 파일을 나열하고, .gitignore 규칙으로 필터링된 파일을 무시하기 위해)
46
+
47
+ 먼저, git으로 관리되고 있는 폴더에서 작업합니다:
48
+
49
+ 환경 변수 설정
50
+
51
+ ```bash
52
+ export OPENAI_API_KEY="sk-xxxxxx" # 필수: 귀하의 OpenAI API Key로 교체하세요
53
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # 선택 사항, 기본값은 OpenAI 공식 API 사용
54
+ export OPENAI_MODEL="gpt-3.5-turbo" # 선택 사항, 기본값은 gpt-3.5-turbo 모델 사용
55
+ ```
56
+
57
+ 사이트 빌드, 다국어 번역 지원. 현재 디렉토리를 소스 디렉토리로 사용하여 `.zen/dist` 디렉토리에 출력합니다.
58
+
59
+ - `--lang` 매개변수를 여러 번 사용하여 생성할 언어 버전을 지정할 수 있습니다 (예: `--lang ko-KR --lang en-US`).
60
+ - `--base-url` 매개변수를 사용하여 사이트의 기본 URL 접두사를 지정할 수 있습니다 (예: GitHub Pages의 저장소 이름).
61
+ - 소스 언어를 구성할 필요가 없으며, ZEN이 자동으로 감지합니다.
62
+
63
+ ```bash
64
+ npx zengen@latest build --lang ko-KR --lang en-US
65
+ ```
66
+
67
+ **더 많은 매개변수 또는 도움말 보기**:
68
+
69
+ ```bash
70
+ npx zengen@latest
71
+ ```
@@ -0,0 +1,71 @@
1
+ ---
2
+ title: ZEN - Minimalistische Markdown + AI Statische Site Generator
3
+ summary: ZEN is een statische sitegenerator gecombineerd met AI, ondersteunt intelligente categorisatie en navigatie en automatische incrementele vertaling, zodat gebruikers zich kunnen concentreren op schrijven in hun moedertaal en het configuratie- en bouwproces wordt vereenvoudigd.
4
+ tags:
5
+ - Statische Site Generator
6
+ - Markdown
7
+ - AI
8
+ - Meertalige Vertaling
9
+ - Minimalisme
10
+ - Documentatietool
11
+ - Node.js
12
+ inferred_lang: nl-NL
13
+ ---
14
+
15
+ # ZEN - Minimalistische Markdown + AI Statische Site Generator
16
+
17
+ [> Website Demo](https://zccz14.github.io/ZEN/)
18
+
19
+ ## Basisfunctionaliteiten
20
+
21
+ 1. 📃 **Statische sitegeneratie**: Bouw een willekeurige git-map met Markdown-bestanden om tot een statische HTML-site.
22
+ 2. 🧭 **Intelligente categorisatie en navigatie**: Gebruik AI voor inhoudsanalyse, genereer een sitemap en navigatie, ongeacht de locatie van de bronbestanden.
23
+ 3. 🌍 **Automatische incrementele vertaling**: Gebruik AI voor incrementele vertaling, zodat gebruikers Markdown in hun moedertaal kunnen schrijven, maar de gebruikers meertalig kunnen zijn.
24
+
25
+ Waarom nog een Markdown statische sitegenerator? Ik heb opnieuw nagedacht over hoe documentatietools in het AI-tijdperk schrijvers beter kunnen dienen:
26
+
27
+ - Terug naar inhoud: Minimaliseer afleiding, focus op schrijven
28
+
29
+ Laat documentatie terugkeren naar de essentie, laat schrijven terugkeren naar rust.
30
+
31
+ Ten eerste, ik wil geen bibliothecaris zijn. Soms wil ik iets opschrijven, maar ik heb misschien nog geen titel bedacht, of een duidelijke structuur. Ik wil dat een LLM automatisch titels voor me genereert, samenvattingen maakt, categoriseert, navigatie creëert en ander organisatiewerk doet.
32
+
33
+ Ten tweede, mijn werkkamer moet opgeruimd zijn. Ik wil geen complexe bouwtools configureren, geen ingewikkelde documentatie-instellingen, geen complexe structuren. Elke keer als ik de configuratiebestanden en projectstructuren van tools zoals Docusaurus, VuePress, Astro zie, krijg ik hoofdpijn. Nu kiest ZEN ervoor om alle configuratie te verbergen in de .zen-map, weg te vegen in een hoekje, zodat gebruikers zich alleen op de inhoud hoeven te concentreren, de rest laat ZEN afhandelen. Alle andere mappen zijn uw schrijfruimte, u kunt uw Markdown-bestanden vrij organiseren.
34
+
35
+ - Terug naar moedertaal: Schrijf in je moedertaal, bouw soepel meertalige versies
36
+
37
+ Het leven is kort, ik heb geen zin om te vertalen. Mensen kunnen hun denkdiepte het best benutten als ze hun moedertaal gebruiken. Maar tegelijkertijd is verbinding met de wereld noodzakelijk, ik wil de meertalige communicatie niet opgeven. Daarom wilde ik een tool die me in staat stelt in mijn moedertaal te schrijven, terwijl meer mensen mijn inhoud kunnen zien. De huidige i18n vereist niet alleen zelfvertaling, maar ook zelfonderhoud van inhoudsupdates, dat is te veel gedoe. Ik kies ervoor om LLM te gebruiken om voor mij te vertalen, dat bespaart me veel tijd en kan meertalige vertalingen met één klik voltooien.
38
+
39
+ ## Snel starten
40
+
41
+ Vereisten:
42
+
43
+ - [Node.js](https://nodejs.org/) geïnstalleerd (aanbevolen versie 18 of hoger, npx-commando nodig)
44
+ - Een [OpenAI API Key](https://platform.openai.com/account/api-keys) verkregen, of een OPENAI-compatibele API Key
45
+ - Git geïnstalleerd (om Markdown-bestanden uit Git op te lijsten, bestanden die door .gitignore-regels worden gefilterd worden genegeerd)
46
+
47
+ Werk eerst in een map die al door git wordt beheerd:
48
+
49
+ Configureer omgevingsvariabelen
50
+
51
+ ```bash
52
+ export OPENAI_API_KEY="sk-xxxxxx" # Verplicht: Vervang door uw OpenAI API Key
53
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # Optioneel, standaard gebruikt het het officiële OpenAI API
54
+ export OPENAI_MODEL="gpt-3.5-turbo" # Optioneel, standaard gebruikt het het gpt-3.5-turbo model
55
+ ```
56
+
57
+ Bouw de site, ondersteunt meertalige vertaling. Gebruik de huidige map als bronmap, uitvoer naar de `.zen/dist` map.
58
+
59
+ - U kunt meerdere keren de parameter `--lang` gebruiken om de te genereren taalversies op te geven (bijv. `--lang nl-NL --lang en-US`).
60
+ - U kunt de parameter `--base-url` gebruiken om het basis-URL-voorvoegsel van de site op te geven (bijv. de repositorynaam op GitHub Pages).
61
+ - Er is geen configuratie van de brontaal nodig, ZEN detecteert dit automatisch.
62
+
63
+ ```bash
64
+ npx zengen@latest build --lang nl-NL --lang en-US
65
+ ```
66
+
67
+ **Bekijk meer parameters of help**:
68
+
69
+ ```bash
70
+ npx zengen@latest
71
+ ```
@@ -0,0 +1,71 @@
1
+ ---
2
+ title: ZEN - Minimalistisk Markdown + AI-statisk nettstedbygger
3
+ summary: ZEN er en statisk nettstedgenerator som kombinerer AI, støtter intelligent kategorisering og navigasjon samt automatisk inkrementell oversettelse. Den lar brukeren fokusere på å skrive på morsmålet og forenkler konfigurasjon og byggeprosessen.
4
+ tags:
5
+ - Statisk nettstedgenerator
6
+ - Markdown
7
+ - AI
8
+ - Flerspråklig oversettelse
9
+ - Minimalisme
10
+ - Dokumentasjonsverktøy
11
+ - Node.js
12
+ inferred_lang: no-NO
13
+ ---
14
+
15
+ # ZEN - Minimalistisk Markdown + AI-statisk nettstedbygger
16
+
17
+ [> Nettsteddemo](https://zccz14.github.io/ZEN/)
18
+
19
+ ## Grunnleggende funksjoner
20
+
21
+ 1. 📃 **Statisk nettstedgenerering**: Bygg en hvilken som helst git-mappe som inneholder Markdown til et statisk HTML-nettsted.
22
+ 2. 🧭 **Intelligent kategoriseringsnavigasjon**: Bruk AI til å analysere innhold, generere nettstedkart og navigasjon. Plasseringen av kildefiler er ikke følsom.
23
+ 3. 🌍 **Automatisk inkrementell oversettelse**: Bruk AI til inkrementell oversettelse, slik at brukeren kan skrive Markdown på morsmålet, men likevel være flerspråklig.
24
+
25
+ Hvorfor lagde jeg enda en Markdown-statisk nettstedgenerator? Jeg tenkte på nytt over hvordan dokumentasjonsverktøy i AI-tiden bedre kan tjene skribenter:
26
+
27
+ - Tilbake til innholdet: Minimaliser forstyrrelser, fokuser på skrivingen
28
+
29
+ La dokumentasjonen gå tilbake til essensen, la skrivingen gå tilbake til roen.
30
+
31
+ For det første vil jeg ikke være bibliotekar. Noen ganger vil jeg skrive ned noe, men jeg har kanskje ikke tenkt ut en tittel ennå, eller organisert det spesielt. Jeg håper at LLM automatisk vil hjelpe meg med å generere titler, lage sammendrag, kategorisere, navigere og annet organisasjonsarbeid.
32
+
33
+ For det andre må mitt skrivebord være rent. Jeg vil ikke ha komplekse konfigurasjonsverktøy, krangle med kompliserte dokumentasjonsoppsett, eller liker komplekse strukturer. Hver gang jeg ser konfigurasjonsfilene og prosjektstrukturene til verktøy som Docusaurus, VuePress, Astro, får jeg hodepine. Nå velger ZEN å skjule all konfigurasjon i .zen-mappen, feie den bort i et hjørne. Brukeren trenger bare å fokusere på å skrive innhold, resten overlater ZEN til å håndtere. Alle andre mapper er ditt skriveområde, du kan organisere Markdown-filene dine som du vil.
34
+
35
+ - Tilbake til morsmålet: Skriv på morsmålet, bygg flerspråklige versjoner sømløst
36
+
37
+ Livet er kort, jeg gidder ikke oversette. Når man bruker morsmålet, kan man utnytte sin egen tankedybde best. Men samtidig er det nødvendig å holde kontakt med verden, jeg vil ikke gi opp flerspråklig kommunikasjon. Derfor ønsker jeg et verktøy som lar meg skrive på morsmålet, samtidig som det lar flere se innholdet mitt. Nåværende i18n krever ikke bare at man oversetter selv, men også at man vedlikeholder innholdsopdateringer selv, det er for mye arbeid. Jeg velger å bruke LLM til å hjelpe meg med oversettelse, det sparer mye tid og kan fullføre oversettelse til flere språk med ett klikk.
38
+
39
+ ## Rask start
40
+
41
+ Forutsetninger:
42
+
43
+ - [Node.js](https://nodejs.org/) er installert (anbefalt versjon 18 eller høyere, må ha npx-kommandoen)
44
+ - Har fått [OpenAI API-nøkkel](https://platform.openai.com/account/api-keys), eller en OPENAI-kompatibel API-nøkkel
45
+ - Git er installert (brukes for å liste Markdown-filer fra Git, ignorerer filer filtrert av .gitignore-regler)
46
+
47
+ Først, arbeid i en mappe som allerede er administrert av git:
48
+
49
+ Konfigurer miljøvariabler
50
+
51
+ ```bash
52
+ export OPENAI_API_KEY="sk-xxxxxx" # Påkrevd: Erstatt med din OpenAI API-nøkkel
53
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # Valgfritt, bruker offisiell OpenAI API som standard
54
+ export OPENAI_MODEL="gpt-3.5-turbo" # Valgfritt, bruker gpt-3.5-turbo-modellen som standard
55
+ ```
56
+
57
+ Bygg nettstedet, støtter flerspråklig oversettelse. Bruk gjeldende mappe som kildekatalog, skriver ut til `.zen/dist`-mappen.
58
+
59
+ - Du kan spesifisere språkversjonene som skal genereres ved å bruke `--lang`-parameteren flere ganger (f.eks. `--lang zh-Hans --lang en-US`).
60
+ - Du kan spesifisere nettstedets basis-URL-prefiks med `--base-url`-parameteren (f.eks. repositorienavnet på GitHub Pages).
61
+ - Kilde språk trenger ikke konfigureres, ZEN vil automatisk oppdage det.
62
+
63
+ ```bash
64
+ npx zengen@latest build --lang zh-Hans --lang en-US
65
+ ```
66
+
67
+ **Se flere parametere eller hjelp**:
68
+
69
+ ```bash
70
+ npx zengen@latest
71
+ ```
@@ -0,0 +1,71 @@
1
+ ---
2
+ title: ZEN - Minimalistyczny generator statycznych stron Markdown + AI
3
+ summary: ZEN to generator statycznych stron zintegrowany z AI, wspierający inteligentną nawigację kategorii i automatyczne tłumaczenie przyrostowe, pozwalający użytkownikom skupić się na pisaniu w języku ojczystym oraz upraszczający proces konfiguracji i budowania.
4
+ tags:
5
+ - generator statycznych stron
6
+ - Markdown
7
+ - AI
8
+ - tłumaczenie wielojęzyczne
9
+ - minimalizm
10
+ - narzędzie do dokumentacji
11
+ - Node.js
12
+ inferred_lang: pl-PL
13
+ ---
14
+
15
+ # ZEN - Minimalistyczny generator statycznych stron Markdown + AI
16
+
17
+ [> Demo strony internetowej](https://zccz14.github.io/ZEN/)
18
+
19
+ ## Podstawowe funkcje
20
+
21
+ 1. 📃 **Generowanie statycznych stron**: Przekształca dowolny folder git zawierający pliki Markdown w statyczną stronę HTML.
22
+ 2. 🧭 **Inteligentna nawigacja kategorii**: Wykorzystuje AI do analizy treści, generując mapę witryny i nawigację, niezależnie od lokalizacji plików źródłowych.
23
+ 3. 🌍 **Automatyczne tłumaczenie przyrostowe**: Wykorzystuje AI do przyrostowego tłumaczenia, pozwalając użytkownikom pisać w Markdown w języku ojczystym, jednocześnie udostępniając treść wielojęzycznie.
24
+
25
+ Dlaczego stworzyłem kolejny generator statycznych stron Markdown? Ponownie przemyślałem, jak narzędzia do dokumentacji w erze AI mogą lepiej służyć pisarzom:
26
+
27
+ - Powrót do treści: Minimalizacja zakłóceń, skupienie na pisaniu
28
+
29
+ Niech dokumentacja wróci do swojej istoty, a pisanie do spokoju.
30
+
31
+ Po pierwsze, nie chcę być bibliotekarzem. Czasami chcę coś napisać, ale może jeszcze nie wymyśliłem tytułu, nie uformowałem jasnej struktury. Chcę, aby LLM automatycznie pomógł mi generować tytuły, tworzyć streszczenia, kategoryzować, nawigować i wykonywać inne prace porządkowe.
32
+
33
+ Po drugie, mój gabinet musi być czysty. Nie chcę skomplikowanych narzędzi do konfiguracji, nie lubię skomplikowanych struktur dokumentów. Za każdym razem, gdy widzę pliki konfiguracyjne i struktury projektów takich narzędzi jak Docusaurus, VuePress, Astro, boli mnie głowa. Teraz ZEN ukrywa całą konfigurację w katalogu `.zen`, zamiatając ją w kąt. Użytkownik musi skupić się tylko na treści, resztą zajmie się ZEN. Wszystkie inne katalogi to Twoja przestrzeń do pisania, możesz dowolnie organizować swoje pliki Markdown.
34
+
35
+ - Powrót do języka ojczystego: Pisz w języku ojczystym, płynnie buduj wersje wielojęzyczne
36
+
37
+ Życie jest krótkie, nie mam ochoty na tłumaczenie. Człowiek najlepiej wykorzystuje głębię swojego myślenia, pisząc w języku ojczystym. Ale jednocześnie konieczne jest utrzymanie połączenia ze światem, nie chcę rezygnować z komunikacji wielojęzycznej. Dlatego chcę narzędzia, które pozwoli mi pisać w języku ojczystym, a jednocześnie udostępnić moje treści większej liczbie osób. Obecne rozwiązania i18n wymagają nie tylko własnego tłumaczenia, ale także samodzielnego utrzymywania aktualizacji treści, co jest zbyt uciążliwe. Wybieram użycie LLM do pomocy w tłumaczeniu, oszczędza mi to dużo czasu i pozwala na tłumaczenie na wiele języków jednym kliknięciem.
38
+
39
+ ## Szybki start
40
+
41
+ Wymagania wstępne:
42
+
43
+ - Zainstalowany [Node.js](https://nodejs.org/) (zalecana wersja 18 lub nowsza, wymagane polecenie `npx`)
44
+ - Uzyskany [Klucz API OpenAI](https://platform.openai.com/account/api-keys) lub kompatybilny klucz API OPENAI
45
+ - Zainstalowany Git (do listowania plików Markdown z gita, ignorując pliki filtrowane przez reguły `.gitignore`)
46
+
47
+ Najpierw pracuj w folderze zarządzanym przez git:
48
+
49
+ Skonfiguruj zmienne środowiskowe
50
+
51
+ ```bash
52
+ export OPENAI_API_KEY="sk-xxxxxx" # Wymagane: zastąp swoim kluczem API OpenAI
53
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # Opcjonalne, domyślnie używa oficjalnego API OpenAI
54
+ export OPENAI_MODEL="gpt-3.5-turbo" # Opcjonalne, domyślnie używa modelu gpt-3.5-turbo
55
+ ```
56
+
57
+ Zbuduj stronę, wspierając tłumaczenie wielojęzyczne. Użyj bieżącego katalogu jako katalogu źródłowego, wynik zostanie zapisany w katalogu `.zen/dist`.
58
+
59
+ - Można wielokrotnie użyć parametru `--lang`, aby określić wersje językowe do wygenerowania (np. `--lang pl-PL --lang en-US`).
60
+ - Można użyć parametru `--base-url`, aby określić podstawowy prefiks URL strony (np. nazwa repozytorium na GitHub Pages).
61
+ - Nie trzeba konfigurować języka źródłowego, ZEN wykryje go automatycznie.
62
+
63
+ ```bash
64
+ npx zengen@latest build --lang pl-PL --lang en-US
65
+ ```
66
+
67
+ **Zobacz więcej parametrów lub uzyskaj pomoc**:
68
+
69
+ ```bash
70
+ npx zengen@latest
71
+ ```
@@ -0,0 +1,71 @@
1
+ ---
2
+ title: ZEN - Construtor de Site Estático Minimalista Markdown + IA
3
+ summary: ZEN é um gerador de site estático integrado com IA, suportando navegação por categorização inteligente e tradução incremental automática, permitindo que os usuários se concentrem em escrever em sua língua materna e simplificando o processo de configuração e construção.
4
+ tags:
5
+ - Gerador de Site Estático
6
+ - Markdown
7
+ - IA
8
+ - Tradução Multilíngue
9
+ - Minimalismo
10
+ - Ferramenta de Documentação
11
+ - Node.js
12
+ inferred_lang: pt-BR
13
+ ---
14
+
15
+ # ZEN - Construtor de Site Estático Minimalista Markdown + IA
16
+
17
+ [> Demonstração do Site](https://zccz14.github.io/ZEN/)
18
+
19
+ ## Funcionalidades Básicas
20
+
21
+ 1. 📃 **Geração de Site Estático**: Transforma qualquer pasta git contendo arquivos Markdown em um site HTML estático.
22
+ 2. 🧭 **Navegação por Categorização Inteligente**: Utiliza IA para análise de conteúdo, gerando mapa do site e navegação, independente da localização dos arquivos fonte.
23
+ 3. 🌍 **Tradução Incremental Automática**: Utiliza IA para tradução incremental, permitindo que o usuário escreva em Markdown usando sua língua materna, mas o conteúdo final pode ser multilíngue.
24
+
25
+ Por que criar mais um gerador de site estático com Markdown? Reflito sobre como as ferramentas de documentação podem servir melhor aos escritores na era da IA:
26
+
27
+ - Retorno ao Conteúdo: Minimizar distrações, focar na escrita
28
+
29
+ Devolver a essência à documentação, devolver a tranquilidade à escrita.
30
+
31
+ Primeiro, não quero ser um bibliotecário. Às vezes quero anotar algo, mas talvez ainda não tenha pensado em um título, ou não tenha uma organização clara. Espero que um LLM (Large Language Model) me ajude automaticamente a gerar títulos, resumos, categorias, navegação e outras tarefas de organização.
32
+
33
+ Segundo, meu escritório precisa estar arrumado. Não quero configurar ferramentas de construção complexas, lidar com configurações de documentação intrincadas, nem gosto de estruturas complicadas. Sempre que vejo os arquivos de configuração e a estrutura de projetos de ferramentas como Docusaurus, VuePress, Astro, fico com dor de cabeça. Agora, o ZEN opta por esconder todas as configurações no diretório `.zen`, varrendo-as para um canto. O usuário só precisa se concentrar no conteúdo da escrita, o resto fica por conta do ZEN. Todos os outros diretórios são seu espaço de escrita, você pode organizar seus arquivos Markdown como quiser.
34
+
35
+ - Retorno à Língua Materna: Escreva em sua língua materna, construa versões multilíngues suavemente
36
+
37
+ A vida é curta, não tenho paciência para traduzir. As pessoas atingem sua máxima profundidade de pensamento quando usam sua língua materna. Mas, ao mesmo tempo, manter-se conectado ao mundo é necessário, não quero abrir mão da comunicação multilíngue. Portanto, desejo uma ferramenta que me permita escrever em minha língua materna e, ao mesmo tempo, permita que mais pessoas vejam meu conteúdo. Atualmente, o i18n exige que você mesmo traduza e ainda mantenha as atualizações do conteúdo, o que é muito trabalhoso. Escolhi usar LLM para me ajudar com a tradução, economizando muito tempo e permitindo a tradução para vários idiomas com um clique.
38
+
39
+ ## Início Rápido
40
+
41
+ Pré-requisitos:
42
+
43
+ - Ter o [Node.js](https://nodejs.org/) instalado (versão 18 ou superior recomendada, necessário comando `npx`)
44
+ - Ter uma [Chave de API da OpenAI](https://platform.openai.com/account/api-keys), ou uma chave de API compatível com OpenAI
45
+ - Ter o Git instalado (para listar arquivos Markdown de um repositório Git, ignorando arquivos filtrados pelas regras do `.gitignore`)
46
+
47
+ Primeiro, trabalhe em uma pasta que já esteja sob controle do Git:
48
+
49
+ Configure as variáveis de ambiente
50
+
51
+ ```bash
52
+ export OPENAI_API_KEY="sk-xxxxxx" # Obrigatório: Substitua pela sua Chave de API da OpenAI
53
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # Opcional, usa a API oficial da OpenAI por padrão
54
+ export OPENAI_MODEL="gpt-3.5-turbo" # Opcional, usa o modelo gpt-3.5-turbo por padrão
55
+ ```
56
+
57
+ Construa o site, com suporte a tradução multilíngue. Usa o diretório atual como fonte e gera a saída no diretório `.zen/dist`.
58
+
59
+ - É possível especificar os idiomas a serem gerados usando o parâmetro `--lang` várias vezes (ex: `--lang pt-BR --lang en-US`).
60
+ - É possível especificar o prefixo da URL base do site usando o parâmetro `--base-url` (ex: nome do repositório no GitHub Pages).
61
+ - Não é necessário configurar o idioma fonte, o ZEN detecta automaticamente.
62
+
63
+ ```bash
64
+ npx zengen@latest build --lang pt-BR --lang en-US
65
+ ```
66
+
67
+ **Veja mais parâmetros ou obtenha ajuda**:
68
+
69
+ ```bash
70
+ npx zengen@latest
71
+ ```