zengen 0.2.0 → 0.2.2

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 (60) hide show
  1. package/.github/workflows/pages.yml +4 -4
  2. package/.zen/meta.json +8 -139
  3. package/.zen/src/de-DE/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  4. package/.zen/src/de-DE/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  5. package/.zen/src/en-US/01d04f7c17b4a541ead9d759d877b30b403e15b849182a49eb1f62bd29ecd18c.md +23 -23
  6. package/.zen/src/en-US/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  7. package/.zen/src/en-US/1b798c44a4f353e47296ca83d5905e37e6aba3e90bbd9bc3b3d34fc12059a2ca.md +2 -2
  8. package/.zen/src/en-US/1e96be58d76c60056b708eb5bd8b8b81d7b5845d9cfe0b879d85068a5f11df3a.md +3 -3
  9. package/.zen/src/en-US/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  10. package/.zen/src/en-US/80ae9bed74fc6348a7c1fe9f33e86b65f5d919169721f77bcf0e1bc29fbdb4f9.md +3 -3
  11. package/.zen/src/en-US/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md +63 -0
  12. package/.zen/src/en-US/f0c2799126931ccd113a0c45b1e623870b0d4f4f400becf6dd877da8f1011517.md +2 -3
  13. package/.zen/src/en-US/fdfca9b960d0eaa8b2b96fe988ead7481d2c0b16f66ebc94fb477139b4178cdc.md +5 -5
  14. package/.zen/src/es-ES/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  15. package/.zen/src/es-ES/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  16. package/.zen/src/fr-FR/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  17. package/.zen/src/fr-FR/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  18. package/.zen/src/ja-JP/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +71 -0
  19. package/.zen/src/ja-JP/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  20. package/.zen/src/ko-KR/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  21. package/.zen/src/pt-PT/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  22. package/.zen/src/pt-PT/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  23. package/.zen/src/ru-RU/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  24. package/.zen/src/ru-RU/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  25. package/.zen/src/zh-Hans/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  26. package/.zen/src/zh-Hans/084ef1f6a0167df8621c673c79211309d4af6c588e7bbe3e043f7c244edd0ac6.md +80 -0
  27. package/.zen/src/zh-Hans/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  28. package/.zen/src/zh-Hans/6124ea88edec5bde737b26b21f71ecfeffe4e73151784856edf813ee231a4baa.md +10 -0
  29. package/.zen/src/zh-Hans/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md +63 -0
  30. package/.zen/src/zh-Hans/f0c2799126931ccd113a0c45b1e623870b0d4f4f400becf6dd877da8f1011517.md +3 -4
  31. package/.zen/src/zh-Hans/fdfca9b960d0eaa8b2b96fe988ead7481d2c0b16f66ebc94fb477139b4178cdc.md +2 -2
  32. package/README.md +27 -21
  33. package/dist/build/pipeline.d.ts.map +1 -1
  34. package/dist/build/pipeline.js +13 -12
  35. package/dist/build/pipeline.js.map +1 -1
  36. package/dist/languages.d.ts +2 -0
  37. package/dist/languages.d.ts.map +1 -0
  38. package/dist/languages.js +14 -0
  39. package/dist/languages.js.map +1 -0
  40. package/dist/process/extractMetadataByAI.d.ts.map +1 -1
  41. package/dist/process/extractMetadataByAI.js +3 -3
  42. package/dist/process/extractMetadataByAI.js.map +1 -1
  43. package/dist/process/template.d.ts.map +1 -1
  44. package/dist/process/template.js +2 -7
  45. package/dist/process/template.js.map +1 -1
  46. package/package.json +2 -2
  47. package/src/build/pipeline.ts +48 -42
  48. package/src/languages.ts +10 -0
  49. package/src/process/extractMetadataByAI.ts +14 -12
  50. package/src/process/template.ts +2 -7
  51. package/.zen/src/zh-Hans/6ad8db715a1b60613fe934fefb29fa981ecad9b63145593accff144d73b44bde.md +0 -175
  52. package/.zen/src/zh-Hans/a1580f71c6c6c1ff4a314be72d410a8507af2f087d56360c7f5048d349c21953.md +0 -48
  53. package/.zen/src/zh-Hans/d49012f98c4367b34034063400e2f7826bf0615952210c82396920172d468e2c.md +0 -107
  54. package/docs/advanced-usage.md +0 -39
  55. package/docs/deployment/github-pages.md +0 -107
  56. package/docs/getting-started.md +0 -26
  57. package/docs/guides/best-practices.md +0 -175
  58. package/docs/guides/config.md +0 -48
  59. package/docs/guides/index.md +0 -51
  60. package/docs/testing/test-document.md +0 -1
@@ -3,7 +3,7 @@ name: Deploy to GitHub Pages
3
3
  on:
4
4
  push:
5
5
  branches: [main]
6
- workflow_dispatch: # 允许手动触发
6
+ workflow_dispatch: # 允许手动触发
7
7
 
8
8
  # 设置 GITHUB_TOKEN 的权限以允许部署到 GitHub Pages
9
9
  permissions:
@@ -13,7 +13,7 @@ permissions:
13
13
 
14
14
  # 只允许一个并发部署,跳过正在运行的队列
15
15
  concurrency:
16
- group: "pages"
16
+ group: 'pages'
17
17
  cancel-in-progress: false
18
18
 
19
19
  jobs:
@@ -35,7 +35,7 @@ jobs:
35
35
 
36
36
  - name: Create documentation site
37
37
  run: |
38
- npx zengen@latest build --base-url /ZEN --lang zh-Hans --lang en-US
38
+ npm run build:doc
39
39
 
40
40
  - name: Setup Pages
41
41
  uses: actions/configure-pages@v4
@@ -55,4 +55,4 @@ jobs:
55
55
  steps:
56
56
  - name: Deploy to GitHub Pages
57
57
  id: deployment
58
- uses: actions/deploy-pages@v4
58
+ uses: actions/deploy-pages@v4
package/.zen/meta.json CHANGED
@@ -2,154 +2,23 @@
2
2
  "version": "1.0.0",
3
3
  "options": {
4
4
  "verbose": true,
5
- "langs": ["zh-Hans", "en-US"]
5
+ "langs": ["zh-Hans", "en-US", "es-ES", "pt-PT", "ja-JP", "de-DE", "fr-FR", "ru-RU", "ko-KR"]
6
6
  },
7
7
  "files": [
8
8
  {
9
- "hash": "1b798c44a4f353e47296ca83d5905e37e6aba3e90bbd9bc3b3d34fc12059a2ca",
9
+ "hash": "48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329",
10
10
  "path": "README.md",
11
11
  "metadata": {
12
12
  "title": "ZEN - Markdown 文档站点构建工具",
13
- "summary": "ZEN 是一个极简的静态站点生成工具,专注于将 Markdown 文件夹构建为 HTML 站点,支持智能导航和 AI 驱动的增量翻译,强调内容优先和跨语言支持,无需复杂配置。",
14
- "tags": ["Markdown", "静态站点生成", "AI 翻译", "极简主义", "多语言", "文档工具", "ZEN"],
13
+ "summary": "ZEN 是一个简洁的 Markdown 静态站点生成工具,强调内容优先和极简主义,利用 AI 实现智能导航和多语言翻译,帮助用户专注于写作而无需复杂配置。",
14
+ "tags": ["Markdown", "静态站点生成", "AI 翻译", "多语言", "极简主义", "文档工具", "ZEN"],
15
15
  "inferred_lang": "zh-Hans",
16
16
  "tokens_used": {
17
- "prompt": 650,
18
- "completion": 124,
19
- "total": 774
20
- }
21
- },
22
- "lastUpdated": "2026-01-05T17:52:25.773Z"
23
- },
24
- {
25
- "hash": "5ec990146b35e00de2630559126ee07f7cdcddeb23b0e8cab3d85b4181353e26",
26
- "path": "docs/advanced-usage.md",
27
- "metadata": {
28
- "title": "ZEN 高级用法指南",
29
- "summary": "本文档介绍了 ZEN 的高级功能,包括自定义 HTML 模板、配置选项(如源目录、输出目录、模板、基础 URL 和多语言支持)以及插件系统,帮助用户扩展和定制 ZEN 工具。",
30
- "tags": ["ZEN", "高级用法", "自定义模板", "配置选项", "插件系统", "文档生成", "多语言支持"],
31
- "inferred_lang": "zh-Hans",
32
- "tokens_used": {
33
- "prompt": 464,
34
- "completion": 120,
35
- "total": 584
36
- }
37
- },
38
- "lastUpdated": "2026-01-05T17:52:30.439Z"
39
- },
40
- {
41
- "hash": "f0c2799126931ccd113a0c45b1e623870b0d4f4f400becf6dd877da8f1011517",
42
- "path": "docs/getting-started.md",
43
- "metadata": {
44
- "title": "快速开始指南",
45
- "summary": "本文档介绍了ZEN文档生成器的快速入门方法,包括安装步骤、基本使用流程和主要特性,帮助用户快速上手。",
46
- "tags": [
47
- "ZEN文档生成器",
48
- "快速开始",
49
- "安装",
50
- "基本用法",
51
- "特性",
52
- "Markdown",
53
- "AI辅助",
54
- "多语言支持"
55
- ],
56
- "inferred_lang": "zh-Hans",
57
- "tokens_used": {
58
- "prompt": 373,
59
- "completion": 102,
60
- "total": 475
61
- }
62
- },
63
- "lastUpdated": "2026-01-05T17:52:38.265Z"
64
- },
65
- {
66
- "hash": "fdfca9b960d0eaa8b2b96fe988ead7481d2c0b16f66ebc94fb477139b4178cdc",
67
- "path": "docs/guides/index.md",
68
- "metadata": {
69
- "title": "ZEN 文档站点示例",
70
- "summary": "介绍 ZEN 文档构建工具,一个极简主义的 Markdown 文档站点生成器,包括特性如极简配置、内容优先、智能导航和多语言支持,以及快速开始指南和代码示例。",
71
- "tags": [
72
- "ZEN",
73
- "文档构建工具",
74
- "Markdown",
75
- "站点生成器",
76
- "极简主义",
77
- "快速开始",
78
- "多语言支持"
79
- ],
80
- "inferred_lang": "zh-Hans",
81
- "tokens_used": {
82
- "prompt": 567,
17
+ "prompt": 1150,
83
18
  "completion": 119,
84
- "total": 686
85
- }
86
- },
87
- "lastUpdated": "2026-01-05T17:52:50.656Z"
88
- },
89
- {
90
- "hash": "6124ea88edec5bde737b26b21f71ecfeffe4e73151784856edf813ee231a4baa",
91
- "path": "docs/testing/test-document.md",
92
- "metadata": {
93
- "title": "Test Document",
94
- "summary": "这是一个测试文档,内容为空,仅包含标题。",
95
- "tags": ["测试", "文档", "示例"],
96
- "inferred_lang": "en-US",
97
- "tokens_used": {
98
- "prompt": 265,
99
- "completion": 58,
100
- "total": 323
101
- }
102
- },
103
- "lastUpdated": "2026-01-05T17:52:52.971Z"
104
- },
105
- {
106
- "hash": "01d04f7c17b4a541ead9d759d877b30b403e15b849182a49eb1f62bd29ecd18c",
107
- "path": "docs/deployment/github-pages.md",
108
- "metadata": {
109
- "title": "GitHub Pages 部署配置",
110
- "summary": "本文档介绍了 ZEN 项目文档站点的 GitHub Pages 部署配置,包括工作流程、触发条件、构建步骤、自定义配置、故障排除和手动触发方法。",
111
- "tags": ["GitHub Pages", "部署配置", "工作流程", "文档构建", "故障排除", "ZEN 项目"],
112
- "inferred_lang": "zh-Hans",
113
- "tokens_used": {
114
- "prompt": 1091,
115
- "completion": 106,
116
- "total": 1197
117
- }
118
- },
119
- "lastUpdated": "2026-01-06T01:26:53.682Z"
120
- },
121
- {
122
- "hash": "1e96be58d76c60056b708eb5bd8b8b81d7b5845d9cfe0b879d85068a5f11df3a",
123
- "path": "docs/guides/best-practices.md",
124
- "metadata": {
125
- "title": "ZEN 文档站点最佳实践",
126
- "summary": "本文档介绍了使用 ZEN 构建文档站点的最佳实践,涵盖多语言管理、性能优化、部署策略、维护建议、常见问题解决方案和高级技巧,旨在帮助用户高效开发和维护文档。",
127
- "tags": ["ZEN", "文档站点", "最佳实践", "性能优化", "部署策略", "多语言管理", "维护建议"],
128
- "inferred_lang": "zh-Hans",
129
- "tokens_used": {
130
- "prompt": 1282,
131
- "completion": 116,
132
- "total": 1398
133
- }
134
- },
135
- "lastUpdated": "2026-01-06T01:26:58.919Z"
136
- },
137
- {
138
- "hash": "80ae9bed74fc6348a7c1fe9f33e86b65f5d919169721f77bcf0e1bc29fbdb4f9",
139
- "path": "docs/guides/config.md",
140
- "metadata": {
141
- "title": "ZEN 配置指南",
142
- "summary": "本文档介绍了 ZEN 工具的配置和使用方法,包括基本命令如构建文档、实时预览和启动开发服务器,以及命令行选项如 --watch、--serve 和 --port 的详细说明。",
143
- "tags": ["ZEN", "配置指南", "命令行", "文档构建", "开发服务器", "极简主义"],
144
- "inferred_lang": "zh-Hans",
145
- "tokens_used": {
146
- "prompt": 669,
147
- "completion": 109,
148
- "total": 778
19
+ "total": 1269
149
20
  }
150
- },
151
- "lastUpdated": "2026-01-06T01:27:03.804Z"
21
+ }
152
22
  }
153
- ],
154
- "timestamp": "2026-01-07T09:59:57.948Z"
23
+ ]
155
24
  }
@@ -0,0 +1,73 @@
1
+ ---
2
+ title: ZEN - Markdown-Dokumentationsseiten-Generator
3
+ summary: ZEN ist ein minimalistisches Tool zur Generierung statischer Seiten aus Markdown, das sich auf das Schreiben von Inhalten konzentriert. Es nutzt KI für Übersetzungen und Navigation, unterstützt den Aufbau mehrsprachiger Seiten und kommt ohne komplexe Konfiguration aus.
4
+ tags:
5
+ - Markdown
6
+ - Static Site Generator
7
+ - KI-Übersetzung
8
+ - Mehrsprachig
9
+ - Minimalismus
10
+ - Dokumentationstool
11
+ - ZEN
12
+ inferred_lang: de-DE
13
+ ---
14
+
15
+ # ZEN - Ein schlankes Tool zum Erstellen von Markdown-Dokumentationsseiten
16
+
17
+ [简体中文](https://zccz14.github.io/ZEN/zh-Hans) | [English](https://zccz14.github.io/ZEN/en-US)
18
+
19
+ Warum noch ein Markdown-Static-Site-Generator? Ich habe überlegt, wie Dokumentationstools im KI-Zeitalter Autoren besser dienen können:
20
+
21
+ - **Zurück zum Inhalt**: Minimale Ablenkung, Fokus auf das Schreiben
22
+
23
+ Lasst die Dokumentation wieder das Wesentliche sein und das Schreiben wieder ruhig.
24
+
25
+ Erstens: Ich möchte kein Bibliothekar sein. Manchmal möchte ich etwas aufschreiben, habe aber vielleicht noch keinen Titel oder eine klare Struktur. Ich wünsche mir, dass eine LLM automatisch Titel generiert, Zusammenfassungen erstellt, kategorisiert und Navigation erstellt – also die organisatorische Arbeit übernimmt.
26
+
27
+ Zweitens: Mein Arbeitsbereich muss aufgeräumt sein. Ich möchte keine komplexen Build-Tools konfigurieren, mich nicht mit komplizierten Dokumenteneinstellungen herumschlagen und keine komplexen Strukturen. Jedes Mal, wenn ich die Konfigurationsdateien und Projektstrukturen von Tools wie Docusaurus, VuePress oder Astro sehe, bekomme ich Kopfschmerzen. ZEN versteckt daher alle Konfigurationen im `.zen`-Verzeichnis – weg in die Ecke. Der Nutzer konzentriert sich nur auf den Inhalt, den Rest erledigt ZEN. Alle anderen Verzeichnisse sind Ihr Schreibbereich, Sie können Ihre Markdown-Dateien frei organisieren.
28
+
29
+ - **Zurück zur Muttersprache**: In der Muttersprache schreiben, mehrsprachige Versionen mühelos erstellen
30
+
31
+ Das Leben ist zu kurz für Übersetzungen. Man denkt am tiefsten in der Muttersprache. Gleichzeitig ist die Verbindung zur Welt wichtig, ich möchte den mehrsprachigen Austausch nicht aufgeben. Daher wünsche ich mir ein Tool, mit dem ich in meiner Muttersprache schreiben kann, aber dennoch viele Menschen meine Inhalte sehen können. Aktuelle i18n-Lösungen erfordern nicht nur eigene Übersetzungen, sondern auch die Pflege von Aktualisierungen – zu aufwändig. Ich nutze eine LLM für Übersetzungen, das spart viel Zeit und ermöglicht Übersetzungen in viele Sprachen mit einem Klick.
32
+
33
+ ## Grundlegende Funktionen
34
+
35
+ 1. **Generierung statischer Seiten**
36
+ - Erstellt aus einem beliebigen Ordner mit Markdown-Dateien eine statische HTML-Website.
37
+
38
+ 2. **Intelligente Navigation**
39
+ - Erzeugt eine Sitemap und Navigation. Die ursprüngliche Verzeichnisstruktur der Markdown-Quelldateien muss nicht beibehalten werden; Dateien können frei verschoben werden.
40
+
41
+ 3. **Inkrementelle i18n-Übersetzung**
42
+ - Nutzt LLM für inkrementelle i18n-Übersetzungen. Der Nutzer schreibt Markdown in seiner Muttersprache, kann aber mehrsprachige Inhalte bereitstellen.
43
+
44
+ ## Designphilosophie
45
+
46
+ - **Minimalismus**: Minimale Konfiguration, maximale Flexibilität.
47
+ - **Inhaltsfokus**: Konzentration auf das Schreiben, nicht auf die Tool-Konfiguration.
48
+ - **KI-gestützt**: Nutzt KI für Übersetzungen und Inhaltsorganisation.
49
+ - **Mehrsprachig**: Unterstützt die Erstellung und Darstellung mehrsprachiger Inhalte.
50
+
51
+ ## Schnellstart
52
+
53
+ ### Empfohlene Verwendung
54
+
55
+ **Es wird empfohlen, in das Verzeichnis mit den Markdown-Dateien zu wechseln und direkt mit dem folgenden Befehl zu beginnen:**
56
+
57
+ ```bash
58
+ # Umgebungsvariablen setzen (entsprechend Ihrer Umgebung anpassen)
59
+ export OPENAI_API_KEY="sk-xxxxxx" # Erforderlich: Bitte durch Ihren OpenAI API Key ersetzen
60
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # Optional, standardmäßig wird die offizielle OpenAI-API verwendet
61
+ export OPENAI_MODEL="gpt-3.5-turbo" # Optional, standardmäßig wird das gpt-3.5-turbo Modell verwendet
62
+
63
+ # Website bauen, mit Unterstützung für mehrsprachige Übersetzungen
64
+ npx zengen@latest build --lang zh-Hans --lang en-US --verbose
65
+ ```
66
+
67
+ **Weitere Parameter oder Hilfe anzeigen**:
68
+
69
+ ```bash
70
+ npx zengen
71
+ ```
72
+
73
+ **Hinweis**: ZEN erzwingt die Verwendung des aktuellen Verzeichnisses als Quellverzeichnis. Die Ausgabe erfolgt ins Verzeichnis `.zen/dist`. Das Angeben von Quell- und Ausgabeverzeichnissen als Parameter wird nicht unterstützt.
@@ -0,0 +1,81 @@
1
+ ---
2
+ title: ZEN - Markdown-Dokumentationsseiten-Generator
3
+ summary: ZEN ist ein minimalistisches, statisches Site-Generierungstool für Markdown, das Inhalte priorisiert und Minimalismus betont. Es nutzt KI für intelligente Navigation und mehrsprachige Übersetzung, um Nutzern zu helfen, sich auf das Schreiben zu konzentrieren, ohne komplexe Konfigurationen.
4
+ tags:
5
+ - Markdown
6
+ - Statische Site-Generierung
7
+ - KI-Übersetzung
8
+ - Mehrsprachig
9
+ - Minimalismus
10
+ - Dokumentationstool
11
+ - ZEN
12
+ inferred_lang: de-DE
13
+ ---
14
+
15
+ # ZEN - Minimalistisches Markdown-Dokumentationsseiten-Tool
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
+ Warum noch ein statischer Markdown-Site-Generator? Ich habe überlegt, wie Dokumentationstools im KI-Zeitalter Autoren besser dienen können:
28
+
29
+ - **Zurück zu den Inhalten**: Minimale Ablenkung, Fokus auf das Schreiben
30
+
31
+ Lasst die Dokumentation zu ihrem Wesen zurückkehren und das Schreiben zur Ruhe.
32
+
33
+ Erstens: Ich möchte kein Bibliothekar sein. Manchmal möchte ich etwas aufschreiben, aber vielleicht habe ich noch keinen Titel dafür oder es ist noch nicht besonders organisiert. Ich wünsche mir, dass eine LLM automatisch Titel generiert, Zusammenfassungen erstellt, kategorisiert, Navigation erstellt und andere organisatorische Aufgaben übernimmt.
34
+
35
+ Zweitens: Mein Arbeitszimmer muss aufgeräumt sein. Ich möchte keine komplexen Build-Tools konfigurieren, mich nicht mit komplizierten Dokumenteneinstellungen herumschlagen und keine komplexen Strukturen. Jedes Mal, wenn ich die Konfigurationsdateien und Projektstrukturen von Tools wie Docusaurus, VuePress oder Astro sehe, bekomme ich Kopfschmerzen. Jetzt versteckt ZEN alle Konfigurationen im `.zen`-Verzeichnis, schiebt sie in die Ecke. Der Nutzer muss sich nur auf den Inhalt konzentrieren, den Rest erledigt ZEN. Alle anderen Verzeichnisse sind Ihr Schreibbereich, Sie können Ihre Markdown-Dateien beliebig organisieren.
36
+
37
+ - **Zurück zur Muttersprache**: In der Muttersprache schreiben, nahtlos mehrsprachige Versionen erstellen
38
+
39
+ Das Leben ist kurz, ich bin zu faul zum Übersetzen. Man denkt am tiefsten in seiner Muttersprache. Gleichzeitig ist es notwendig, mit der Welt verbunden zu bleiben, ich möchte den mehrsprachigen Austausch nicht aufgeben. Daher wünsche ich mir ein Tool, mit dem ich in meiner Muttersprache schreiben kann, aber gleichzeitig mehr Menschen meine Inhalte zugänglich machen kann. Aktuelle i18n-Lösungen erfordern nicht nur eigene Übersetzungen, sondern auch die Pflege von Inhaltsaktualisierungen – das ist zu umständlich. Ich nutze LLMs für Übersetzungen, das spart mir viel Zeit und mehrsprachige Übersetzungen sind mit einem Klick erledigt.
40
+
41
+ ## Grundlegende Funktionen
42
+
43
+ 1. **Statische Site-Generierung**
44
+ - Erstellt aus einem beliebigen Ordner mit Markdown-Dateien eine statische HTML-Website.
45
+
46
+ 2. **Intelligente Navigation**
47
+ - Generiert eine Sitemap und Navigation. Die ursprüngliche Verzeichnisstruktur der Markdown-Quelldateien muss nicht beibehalten werden, Quelldateien können beliebig verschoben werden.
48
+
49
+ 3. **Inkrementelle i18n-Übersetzung**
50
+ - Nutzt LLMs für inkrementelle i18n-Übersetzungen. Nutzer schreiben Markdown in ihrer Muttersprache, können aber mehrsprachige Inhalte bereitstellen.
51
+
52
+ ## Designphilosophie
53
+
54
+ - **Minimalismus**: Minimale Konfiguration, maximale Flexibilität.
55
+ - **Inhalte zuerst**: Fokus auf das Schreiben, nicht auf Tool-Konfiguration.
56
+ - **KI-gestützt**: Nutzt KI für Übersetzung und Inhaltsorganisation.
57
+ - **Mehrsprachig**: Unterstützt mehrsprachige Inhaltserstellung und -darstellung.
58
+
59
+ ## Schnellstart
60
+
61
+ ### Empfohlene Verwendung
62
+
63
+ **Es wird empfohlen, in das Verzeichnis mit den Markdown-Dateien zu wechseln und direkt mit dem folgenden Befehl mit dem Build zu beginnen:**
64
+
65
+ ```bash
66
+ # Umgebungsvariablen setzen (an Ihre Situation anpassen)
67
+ export OPENAI_API_KEY="sk-xxxxxx" # Erforderlich: Bitte durch Ihren OpenAI API Key ersetzen
68
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # Optional, standardmäßig wird die offizielle OpenAI-API verwendet
69
+ export OPENAI_MODEL="gpt-3.5-turbo" # Optional, standardmäßig wird das gpt-3.5-turbo-Modell verwendet
70
+
71
+ # Site bauen, mit mehrsprachiger Übersetzungsunterstützung
72
+ npx zengen@latest build --lang zh-Hans --lang en-US --verbose
73
+ ```
74
+
75
+ **Weitere Parameter oder Hilfe anzeigen**:
76
+
77
+ ```bash
78
+ npx zengen
79
+ ```
80
+
81
+ **Hinweis**: ZEN erzwingt die Verwendung des aktuellen Verzeichnisses als Quellverzeichnis und gibt die Dateien im Verzeichnis `.zen/dist` aus. Das Angeben von Quell- und Ausgabeverzeichnissen als Parameter wird nicht unterstützt.
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: GitHub Pages Deployment Configuration
3
- summary: This document describes the GitHub Pages deployment configuration for the ZEN project documentation site, including workflow, triggers, build steps, custom configurations, troubleshooting, and manual triggering methods.
3
+ summary: This document describes the GitHub Pages deployment configuration for the ZEN project documentation site, including workflow, trigger conditions, build steps, custom configuration, troubleshooting, and manual trigger methods.
4
4
  tags:
5
5
  - GitHub Pages
6
6
  - Deployment Configuration
@@ -21,7 +21,7 @@ This directory contains the GitHub Pages deployment configuration for the ZEN pr
21
21
 
22
22
  This workflow automatically builds the ZEN project documentation site and deploys it to GitHub Pages.
23
23
 
24
- **Triggers:**
24
+ **Trigger Conditions:**
25
25
 
26
26
  - Push to the `main` branch (when changes occur in `demo/src/`, `package.json`, or workflow files)
27
27
  - Pull Request targeting the `main` branch
@@ -29,20 +29,20 @@ This workflow automatically builds the ZEN project documentation site and deploy
29
29
 
30
30
  **Workflow Steps:**
31
31
 
32
- 1. **Checkout code**: Checks out code from the remote branch to ensure code synchronization.
33
- 2. **Setup Node.js**: Configures the Node.js 20.x environment.
34
- 3. **Install dependencies**: Installs project dependencies using `npm ci`.
35
- 4. **Build zengen**: Builds the local zengen package.
36
- 5. **Install zengen**: Installs the locally built zengen as a global tool.
37
- 6. **Test zengen CLI**: Verifies the CLI tool works correctly.
38
- 7. **Build documentation site**: Builds the documentation using `cd demo/src && zengen build`, outputting to the `.zen/dist` directory.
39
- 8. **Configure Pages**: Sets up GitHub Pages.
40
- 9. **Upload artifact**: Uploads the built documentation site as a Pages artifact.
41
- 10. **Deploy to GitHub Pages**: Automatically deploys to GitHub Pages.
32
+ 1. **Checkout code**: Check out code from the remote branch to ensure code synchronization.
33
+ 2. **Set up Node.js**: Configure the Node.js 20.x environment.
34
+ 3. **Install dependencies**: Install project dependencies using `npm ci`.
35
+ 4. **Build zengen**: Build the local zengen package.
36
+ 5. **Install zengen**: Install the locally built zengen as a global tool.
37
+ 6. **Test zengen CLI**: Verify the CLI tool functions correctly.
38
+ 7. **Build documentation site**: Build the documentation using `cd demo/src && zengen build`, outputting to the `.zen/dist` directory.
39
+ 8. **Configure Pages**: Set up GitHub Pages.
40
+ 9. **Upload artifact**: Upload the built documentation site as a Pages artifact.
41
+ 10. **Deploy to GitHub Pages**: Automatically deploy to GitHub Pages.
42
42
 
43
43
  ## Accessing the Documentation Site
44
44
 
45
- After successful deployment, the documentation site will be accessible at:
45
+ After successful deployment, the documentation site will be accessible at the following URL:
46
46
 
47
47
  ```
48
48
  https://[username].github.io/[repository-name]/
@@ -55,7 +55,7 @@ https://[username].github.io/[repository-name]/
55
55
  If a custom domain is needed, you can add a CNAME file after the build step:
56
56
 
57
57
  ```yaml
58
- # Create CNAME file (if custom domain is needed)
58
+ # Create CNAME file (if a custom domain is needed)
59
59
  echo "docs.example.com" > docs-dist/CNAME
60
60
  ```
61
61
 
@@ -70,10 +70,10 @@ zengen build --verbose
70
70
 
71
71
  Available options:
72
72
 
73
- - `--verbose`: Shows verbose output.
73
+ - `--verbose`: Show verbose output.
74
74
  - `--watch`: Watch mode (not suitable for CI/CD).
75
- - `--template`: Specifies a custom template file.
76
- - `--config`: Specifies a configuration file.
75
+ - `--template`: Specify a custom template file.
76
+ - `--config`: Specify a configuration file.
77
77
 
78
78
  ### Environment Variables
79
79
 
@@ -84,24 +84,24 @@ The workflow uses the following environment variables:
84
84
 
85
85
  ## Troubleshooting
86
86
 
87
- ### Build Failures
87
+ ### Build Failure
88
88
 
89
89
  1. **Check Node.js version**: Ensure a supported Node.js version is used.
90
90
  2. **Verify dependency installation**: Ensure `npm ci` executes successfully.
91
91
  3. **Check build output**: Review the verbose output of `zengen build`.
92
92
  4. **CLI output directory issue**: ZEN now forces output to the `.zen/dist` directory and no longer supports the `--out` parameter.
93
93
 
94
- ### Deployment Failures
94
+ ### Deployment Failure
95
95
 
96
96
  1. **Check permissions**: Ensure the workflow has correct write permissions for Pages.
97
97
  2. **Verify artifact**: Ensure the `.zen/dist` directory contains valid HTML files.
98
98
  3. **Review logs**: Check GitHub Actions logs for detailed error messages.
99
99
 
100
- ### Documentation Not Updating
100
+ ### Documentation Not Updated
101
101
 
102
- 1. **Check triggers**: Ensure files in the `demo/src/` directory were modified.
103
- 2. **Wait for deployment**: GitHub Pages deployment may take a few minutes.
104
- 3. **Clear browser cache**: The browser might be caching an old version.
102
+ 1. **Check trigger conditions**: Ensure files in the `demo/src/` directory were modified.
103
+ 2. **Wait for deployment completion**: GitHub Pages deployment may take a few minutes.
104
+ 3. **Clear browser cache**: The browser may be caching an old version.
105
105
 
106
106
  ## Manual Trigger
107
107
 
@@ -0,0 +1,73 @@
1
+ ---
2
+ title: ZEN - Markdown Documentation Site Builder
3
+ summary: ZEN is a minimalist Markdown static site generator focused on content writing. It leverages AI for translation and navigation, supports multilingual builds, and requires no complex configuration.
4
+ tags:
5
+ - Markdown
6
+ - Static Site Generator
7
+ - AI Translation
8
+ - Multilingual
9
+ - Minimalism
10
+ - Documentation Tool
11
+ - ZEN
12
+ inferred_lang: en-US
13
+ ---
14
+
15
+ # ZEN - A Minimalist Markdown Documentation Site Builder
16
+
17
+ [简体中文](https://zccz14.github.io/ZEN/zh-Hans) | [English](https://zccz14.github.io/ZEN/en-US)
18
+
19
+ Why create another Markdown static site generator? I've been rethinking how documentation tools can better serve writers in the AI era:
20
+
21
+ - **Return to Content**: Minimize distractions, focus on writing.
22
+
23
+ Let documentation return to its essence, and let writing return to tranquility.
24
+
25
+ First, I don't want to be a librarian. Sometimes I want to jot down some content, but I might not have thought of a title yet, or haven't formed a specific structure. I hope LLMs will automatically help me generate titles, summaries, categorize, and organize navigation.
26
+
27
+ Second, my study must be kept tidy. I don't want complex build tools, fiddling with intricate documentation configurations, or complicated structures. Every time I see the configuration files and project structures of tools like Docusaurus, VuePress, or Astro, my head hurts. Now, ZEN chooses to hide all configurations in the `.zen` directory, swept into a corner. Users only need to focus on writing content; everything else is handled by ZEN. All other directories are your writing space; you can organize your Markdown files however you like.
28
+
29
+ - **Return to Native Language**: Write in your native language, build multilingual versions seamlessly.
30
+
31
+ Life is short; I'm too lazy to translate. People can best express the depth of their thinking when using their native language. Yet, staying connected to the world is necessary; I don't want to give up multilingual communication. So, I wanted a tool that allows me to write in my native language while enabling more people to see my content. Current i18n solutions not only require manual translation but also self-maintenance of content updates, which is too troublesome. I choose to use LLMs to handle translation for me, saving a lot of time and enabling one-click translation into multiple languages.
32
+
33
+ ## Core Features
34
+
35
+ 1. **Static Site Generation**
36
+ - Build any folder containing Markdown files into a static HTML site.
37
+
38
+ 2. **Intelligent Navigation**
39
+ - Generate site maps and navigation. You don't need to maintain the original directory structure of the Markdown source files; you can move source files around freely.
40
+
41
+ 3. **Incremental i18n Translation**
42
+ - Use LLMs for incremental i18n translation, allowing users to write Markdown in their native language while the site can be multilingual.
43
+
44
+ ## Design Philosophy
45
+
46
+ - **Minimalism**: Minimal configuration, maximum flexibility.
47
+ - **Content First**: Focus on writing, not tool configuration.
48
+ - **AI-Powered**: Leverage AI for translation and content organization.
49
+ - **Cross-Language**: Support multilingual content creation and display.
50
+
51
+ ## Quick Start
52
+
53
+ ### Recommended Usage
54
+
55
+ **It is recommended to switch to the directory containing your Markdown files and directly use the following command to start building:**
56
+
57
+ ```bash
58
+ # Set environment variables (modify according to your actual situation)
59
+ export OPENAI_API_KEY="sk-xxxxxx" # Required: Replace with your OpenAI API Key
60
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # Optional, defaults to the official OpenAI API
61
+ export OPENAI_MODEL="gpt-3.5-turbo" # Optional, defaults to the gpt-3.5-turbo model
62
+
63
+ # Build the site with support for multilingual translation
64
+ npx zengen@latest build --lang zh-Hans --lang en-US --verbose
65
+ ```
66
+
67
+ **To view more parameters or help**:
68
+
69
+ ```bash
70
+ npx zengen
71
+ ```
72
+
73
+ **Note**: ZEN enforces using the current directory as the source directory and outputs to the `.zen/dist` directory. It does not support specifying source and output directory parameters.
@@ -29,10 +29,10 @@ Life is short, I use AI translation. Stay connected with the world.
29
29
  ## Core Features
30
30
 
31
31
  1. **Static Site Generation**
32
- - Build any folder containing Markdown files into a static HTML site.
32
+ - Build a static HTML site from any folder containing Markdown files.
33
33
 
34
34
  2. **Intelligent Navigation**
35
- - Generate site maps and navigation without needing to maintain the original directory structure of the Markdown source files.
35
+ - Generate site maps and navigation without needing to preserve the original directory structure of the Markdown source files.
36
36
 
37
37
  3. **Incremental i18n Translation**
38
38
  - Use LLM for incremental i18n translation, allowing users to write Markdown in their native language while supporting multilingual audiences.
@@ -23,7 +23,7 @@ This document introduces best practices for building documentation sites using Z
23
23
  1. **Primary Language First**: Write the complete documentation in your native language first.
24
24
  2. **Incremental Translation**: Only translate modified parts after each update.
25
25
  3. **Terminology Consistency**: Create a glossary to maintain translation consistency.
26
- 4. **Human Proofreading**: It is recommended to perform human proofreading after AI translation.
26
+ 4. **Human Review**: It is recommended to perform human review after AI translation.
27
27
 
28
28
  ## Performance Optimization
29
29
 
@@ -31,7 +31,7 @@ This document introduces best practices for building documentation sites using Z
31
31
 
32
32
  1. **Incremental Builds**: Use `--watch` mode for development.
33
33
  2. **Cache Utilization**: ZEN automatically caches processing results.
34
- 3. **Parallel Processing**: Automatically processes files in parallel on multi-core CPUs.
34
+ 3. **Parallel Processing**: Files are automatically processed in parallel on multi-core CPUs.
35
35
 
36
36
  ### Development Workflow
37
37
 
@@ -144,7 +144,7 @@ rm -rf .zen/cache
144
144
 
145
145
  - Provide context to the AI translator.
146
146
  - Create a glossary to improve consistency.
147
- - Perform human proofreading for critical content.
147
+ - Perform human review for critical content.
148
148
  - Adjust translation prompts.
149
149
 
150
150
  ### Complex Navigation Structure
@@ -0,0 +1,81 @@
1
+ ---
2
+ title: ZEN - Markdown Documentation Site Builder
3
+ summary: ZEN is a clean Markdown static site generator that emphasizes content-first and minimalism. It leverages AI for intelligent navigation and multilingual translation, helping users focus on writing without complex configurations.
4
+ tags:
5
+ - Markdown
6
+ - Static Site Generator
7
+ - AI Translation
8
+ - Multilingual
9
+ - Minimalism
10
+ - Documentation Tool
11
+ - ZEN
12
+ inferred_lang: en-US
13
+ ---
14
+
15
+ # ZEN - A Clean Markdown Documentation Site Builder
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
+ Why create another Markdown static site generator? I've rethought how documentation tools can better serve writers in the AI era:
28
+
29
+ - **Return to Content**: Minimize distractions, focus on writing
30
+
31
+ Let documentation return to its essence, let writing return to tranquility.
32
+
33
+ First, I don't want to be a librarian. Sometimes I want to jot down some content, but I might not have thought of its title yet, or haven't formed a specific organization. I hope LLMs will automatically help me generate titles, create summaries, categorize, navigate, and handle other organizational tasks.
34
+
35
+ Second, my study must be kept clean. I don't want complex build tools, fiddling with intricate documentation configurations, or complicated structures. Every time I see the configuration files and project structures of tools like Docusaurus, VuePress, or Astro, I get a headache. Now, ZEN chooses to hide all configurations in the `.zen` directory, sweeping them into a corner. Users only need to focus on writing content; everything else is handled by ZEN. All other directories are your writing space; you can organize your Markdown files however you like.
36
+
37
+ - **Return to Native Language**: Write in your native language, smoothly build multilingual versions
38
+
39
+ Life is short; I'm too lazy to translate. People can best express the depth of their thinking when using their native language. But staying connected with the world is also necessary; I don't want to give up multilingual communication. So, I want a tool that lets me write in my native language while allowing more people to see my content. Current i18n solutions not only require you to translate yourself but also maintain content updates, which is too troublesome. I choose to use LLMs to help with translation, saving me a lot of time and enabling one-click multilingual translation.
40
+
41
+ ## Core Features
42
+
43
+ 1. **Static Site Generation**
44
+ - Build any folder containing Markdown files into a static HTML site.
45
+
46
+ 2. **Intelligent Navigation**
47
+ - Generate site maps and navigation. You don't need to maintain the original directory structure of the Markdown source files; you can move source files around freely.
48
+
49
+ 3. **Incremental i18n Translation**
50
+ - Use LLMs for incremental i18n translation, allowing users to write Markdown in their native language while the site can be multilingual.
51
+
52
+ ## Design Philosophy
53
+
54
+ - **Minimalism**: Minimal configuration, maximum flexibility.
55
+ - **Content-First**: Focus on writing, not tool configuration.
56
+ - **AI-Powered**: Leverage AI for translation and content organization.
57
+ - **Cross-Language**: Support multilingual content creation and display.
58
+
59
+ ## Quick Start
60
+
61
+ ### Recommended Usage
62
+
63
+ **It is recommended that users switch to the directory containing Markdown files and directly use the following command to start building:**
64
+
65
+ ```bash
66
+ # Set environment variables (modify according to your actual situation)
67
+ export OPENAI_API_KEY="sk-xxxxxx" # Required: Please replace with your OpenAI API Key
68
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # Optional, defaults to the official OpenAI API
69
+ export OPENAI_MODEL="gpt-3.5-turbo" # Optional, defaults to the gpt-3.5-turbo model
70
+
71
+ # Build the site, supporting multilingual translation
72
+ npx zengen@latest build --lang zh-Hans --lang en-US --verbose
73
+ ```
74
+
75
+ **View more parameters or help**:
76
+
77
+ ```bash
78
+ npx zengen
79
+ ```
80
+
81
+ **Note**: ZEN enforces using the current directory as the source directory and outputs to the `.zen/dist` directory. It does not support specifying source and output directory parameters.