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
@@ -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:
@@ -33,9 +33,12 @@ jobs:
33
33
  node-version: '24.x'
34
34
  cache: 'npm'
35
35
 
36
+ - name: Install dependencies
37
+ run: npm install
38
+
36
39
  - name: Create documentation site
37
40
  run: |
38
- npx zengen@latest build --base-url /ZEN --lang zh-Hans --lang en-US
41
+ npm run build:doc
39
42
 
40
43
  - name: Setup Pages
41
44
  uses: actions/configure-pages@v4
@@ -55,4 +58,4 @@ jobs:
55
58
  steps:
56
59
  - name: Deploy to GitHub Pages
57
60
  id: deployment
58
- uses: actions/deploy-pages@v4
61
+ uses: actions/deploy-pages@v4
package/.zen/meta.json CHANGED
@@ -2,134 +2,56 @@
2
2
  "version": "1.0.0",
3
3
  "options": {
4
4
  "verbose": true,
5
- "langs": ["zh-Hans", "en-US"]
5
+ "langs": [
6
+ "zh-Hans",
7
+ "en-US",
8
+ "ja-JP",
9
+ "ko-KR",
10
+ "es-ES",
11
+ "fr-FR",
12
+ "de-DE",
13
+ "ru-RU",
14
+ "pt-PT",
15
+ "it-IT",
16
+ "nl-NL",
17
+ "pl-PL",
18
+ "sv-SE",
19
+ "fi-FI",
20
+ "da-DK",
21
+ "no-NO",
22
+ "zh-Hant",
23
+ "hi-IN",
24
+ "ar-SA",
25
+ "th-TH",
26
+ "vi-VN",
27
+ "id-ID",
28
+ "pt-BR",
29
+ "es-MX",
30
+ "tr-TR",
31
+ "uk-UA"
32
+ ]
6
33
  },
7
34
  "files": [
8
35
  {
9
- "hash": "1b798c44a4f353e47296ca83d5905e37e6aba3e90bbd9bc3b3d34fc12059a2ca",
36
+ "hash": "74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805",
10
37
  "path": "README.md",
11
38
  "metadata": {
12
- "title": "ZEN - Markdown 文档站点构建工具",
13
- "summary": "ZEN 是一个极简的静态站点生成工具,专注于将 Markdown 文件夹构建为 HTML 站点,支持智能导航和 AI 驱动的增量翻译,强调内容优先和跨语言支持,无需复杂配置。",
14
- "tags": ["Markdown", "静态站点生成", "AI 翻译", "极简主义", "多语言", "文档工具", "ZEN"],
15
- "inferred_lang": "zh-Hans",
16
- "tokens_used": {
17
- "prompt": 650,
18
- "completion": 124,
19
- "total": 774
20
- }
21
- }
22
- },
23
- {
24
- "hash": "5ec990146b35e00de2630559126ee07f7cdcddeb23b0e8cab3d85b4181353e26",
25
- "path": "docs/advanced-usage.md",
26
- "metadata": {
27
- "title": "ZEN 高级用法指南",
28
- "summary": "本文档介绍了 ZEN 的高级功能,包括自定义 HTML 模板、配置选项(如源目录、输出目录、模板、基础 URL 和多语言支持)以及插件系统,帮助用户扩展和定制 ZEN 工具。",
29
- "tags": ["ZEN", "高级用法", "自定义模板", "配置选项", "插件系统", "文档生成", "多语言支持"],
30
- "inferred_lang": "zh-Hans",
31
- "tokens_used": {
32
- "prompt": 464,
33
- "completion": 120,
34
- "total": 584
35
- }
36
- }
37
- },
38
- {
39
- "hash": "01d04f7c17b4a541ead9d759d877b30b403e15b849182a49eb1f62bd29ecd18c",
40
- "path": "docs/deployment/github-pages.md",
41
- "metadata": {
42
- "title": "GitHub Pages 部署配置",
43
- "summary": "本文档介绍了 ZEN 项目文档站点的 GitHub Pages 部署配置,包括工作流程、触发条件、构建步骤、自定义配置、故障排除和手动触发方法。",
44
- "tags": ["GitHub Pages", "部署配置", "工作流程", "文档构建", "故障排除", "ZEN 项目"],
45
- "inferred_lang": "zh-Hans",
46
- "tokens_used": {
47
- "prompt": 1091,
48
- "completion": 106,
49
- "total": 1197
50
- }
51
- }
52
- },
53
- {
54
- "hash": "f0c2799126931ccd113a0c45b1e623870b0d4f4f400becf6dd877da8f1011517",
55
- "path": "docs/getting-started.md",
56
- "metadata": {
57
- "title": "快速开始指南",
58
- "summary": "本文档介绍如何快速开始使用 ZEN 文档生成器,包括安装步骤、基本用法和主要特性。",
59
- "tags": ["ZEN 文档生成器", "快速开始", "安装", "基本用法", "特性", "Markdown", "构建命令"],
60
- "inferred_lang": "zh-Hans",
61
- "tokens_used": {
62
- "prompt": 373,
63
- "completion": 94,
64
- "total": 467
65
- }
66
- }
67
- },
68
- {
69
- "hash": "1e96be58d76c60056b708eb5bd8b8b81d7b5845d9cfe0b879d85068a5f11df3a",
70
- "path": "docs/guides/best-practices.md",
71
- "metadata": {
72
- "title": "ZEN 文档站点最佳实践",
73
- "summary": "本文档介绍了使用 ZEN 构建文档站点的最佳实践,涵盖多语言管理、性能优化、部署策略、维护建议、常见问题解决方案和高级技巧,旨在帮助用户高效开发和维护文档。",
74
- "tags": ["ZEN", "文档站点", "最佳实践", "性能优化", "部署策略", "多语言管理", "维护建议"],
75
- "inferred_lang": "zh-Hans",
76
- "tokens_used": {
77
- "prompt": 1282,
78
- "completion": 116,
79
- "total": 1398
80
- }
81
- }
82
- },
83
- {
84
- "hash": "80ae9bed74fc6348a7c1fe9f33e86b65f5d919169721f77bcf0e1bc29fbdb4f9",
85
- "path": "docs/guides/config.md",
86
- "metadata": {
87
- "title": "ZEN 配置指南",
88
- "summary": "本文档介绍了 ZEN 工具的配置和使用方法,包括基本命令如构建文档、实时预览和启动开发服务器,以及命令行选项如 --watch、--serve 和 --port 的详细说明。",
89
- "tags": ["ZEN", "配置指南", "命令行", "文档构建", "开发服务器", "极简主义"],
90
- "inferred_lang": "zh-Hans",
91
- "tokens_used": {
92
- "prompt": 669,
93
- "completion": 109,
94
- "total": 778
95
- }
96
- }
97
- },
98
- {
99
- "hash": "fdfca9b960d0eaa8b2b96fe988ead7481d2c0b16f66ebc94fb477139b4178cdc",
100
- "path": "docs/guides/index.md",
101
- "metadata": {
102
- "title": "ZEN 文档站点示例",
103
- "summary": "介绍 ZEN 文档构建工具,一个极简主义的 Markdown 文档站点生成器,包括特性、快速开始指南、代码示例和下一步学习资源。",
39
+ "title": "ZEN - 极简主义 Markdown + AI 静态站点构建器",
40
+ "summary": "ZEN 是一个结合 AI 的静态站点生成器,支持智能分类导航和自动增量翻译,让用户专注于用母语写作,简化配置和构建过程。",
104
41
  "tags": [
105
- "ZEN",
106
- "文档构建工具",
42
+ "静态站点生成器",
107
43
  "Markdown",
108
- "站点生成器",
109
- "快速开始",
110
- "代码示例",
111
- "多语言支持"
44
+ "AI",
45
+ "多语言翻译",
46
+ "极简主义",
47
+ "文档工具",
48
+ "Node.js"
112
49
  ],
113
50
  "inferred_lang": "zh-Hans",
114
51
  "tokens_used": {
115
- "prompt": 567,
116
- "completion": 108,
117
- "total": 675
118
- }
119
- }
120
- },
121
- {
122
- "hash": "6124ea88edec5bde737b26b21f71ecfeffe4e73151784856edf813ee231a4baa",
123
- "path": "docs/testing/test-document.md",
124
- "metadata": {
125
- "title": "Test Document",
126
- "summary": "这是一个测试文档,内容为空,仅包含标题。",
127
- "tags": ["测试", "文档", "示例"],
128
- "inferred_lang": "en-US",
129
- "tokens_used": {
130
- "prompt": 265,
131
- "completion": 58,
132
- "total": 323
52
+ "prompt": 1038,
53
+ "completion": 120,
54
+ "total": 1158
133
55
  }
134
56
  }
135
57
  }
@@ -0,0 +1,71 @@
1
+ ---
2
+ title: ZEN - منشئ مواقع ثابتة بالحد الأدنى من Markdown + الذكاء الاصطناعي
3
+ summary: ZEN هو منشئ مواقع ثابتة مدمج مع الذكاء الاصطناعي، يدعم التنقل الذكي التلقائي والترجمة التزايدية الآلية، مما يمكن المستخدم من التركيز على الكتابة بلغته الأم، وتبسيط عمليات التكوين والبناء.
4
+ tags:
5
+ - منشئ مواقع ثابتة
6
+ - Markdown
7
+ - الذكاء الاصطناعي
8
+ - ترجمة متعددة اللغات
9
+ - الحد الأدنى
10
+ - أدوات التوثيق
11
+ - Node.js
12
+ inferred_lang: ar-SA
13
+ ---
14
+
15
+ # ZEN - منشئ مواقع ثابتة بالحد الأدنى من Markdown + الذكاء الاصطناعي
16
+
17
+ [> عرض موقع الويب التجريبي](https://zccz14.github.io/ZEN/)
18
+
19
+ ## الوظائف الأساسية
20
+
21
+ 1. 📃 **إنشاء موقع ثابت**: يحول أي مجلد git يحتوي على Markdown إلى موقع HTML ثابت.
22
+ 2. 🧭 **التنقل الذكي التلقائي**: يستخدم الذكاء الاصطناعي لتحليل المحتوى، وإنشاء خريطة موقع وتنقل، دون الحساسية لموقع الملفات المصدر.
23
+ 3. 🌍 **الترجمة التزايدية الآلية**: يستخدم الذكاء الاصطناعي للترجمة التزايدية، مما يمكن المستخدم من كتابة Markdown بلغته الأم، مع إمكانية تعدد اللغات للمستخدم.
24
+
25
+ لماذا تم إنشاء منشئ موقع ثابت آخر من Markdown؟ لقد فكرت مرة أخرى في كيفية خدمة أدوات التوثيق للكتاب بشكل أفضل في عصر الذكاء الاصطناعي:
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 (لإدراج ملفات Markdown من Git، وتجاهل الملفات التي تمت تصفيتها بواسطة قواعد .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 ar-SA --lang en-US`).
60
+ - يمكن تحديد بادئة عنوان URL الأساسي للموقع باستخدام معلمة `--base-url` (على سبيل المثال اسم المستودع على GitHub Pages).
61
+ - لا حاجة لتكوين لغة المصدر، سيكتشف ZEN تلقائيًا.
62
+
63
+ ```bash
64
+ npx zengen@latest build --lang ar-SA --lang en-US
65
+ ```
66
+
67
+ **عرض المزيد من المعلمات أو المساعدة**:
68
+
69
+ ```bash
70
+ npx zengen@latest
71
+ ```
@@ -0,0 +1,71 @@
1
+ ---
2
+ title: ZEN - Minimalistisk Markdown + AI statisk site-generator
3
+ summary: ZEN er en statisk site-generator kombineret med AI, der understøtter intelligent kategorisering og navigation samt automatisk inkrementel oversættelse. Det lader brugeren fokusere på at skrive på deres modersmål og forenkler konfigurations- og byggeprocessen.
4
+ tags:
5
+ - Statisk site-generator
6
+ - Markdown
7
+ - AI
8
+ - Flersproget oversættelse
9
+ - Minimalisme
10
+ - Dokumentationsværktøj
11
+ - Node.js
12
+ inferred_lang: da-DK
13
+ ---
14
+
15
+ # ZEN - Minimalistisk Markdown + AI statisk site-generator
16
+
17
+ [> Website Demo](https://zccz14.github.io/ZEN/)
18
+
19
+ ## Grundlæggende funktioner
20
+
21
+ 1. 📃 **Statisk site-generering**: Bygger en mappe med Markdown-filer (styret af git) om til et statisk HTML-site.
22
+ 2. 🧭 **Intelligent kategorisering og navigation**: Bruger AI til at analysere indhold og generere et site-map og navigation. Placeringen af kildefiler er ikke afgørende.
23
+ 3. 🌍 **Automatisk inkrementel oversættelse**: Bruger AI til inkrementel oversættelse, så brugeren kan skrive Markdown på deres modersmål, mens sitet kan være flersproget.
24
+
25
+ Hvorfor endnu en Markdown statisk site-generator? Jeg har genovervejet, hvordan dokumentationsværktøjer i AI-tidsalderen bedre kan tjene forfattere:
26
+
27
+ - Tilbage til indholdet: Minimér forstyrrelser, fokuser på skrivningen
28
+
29
+ Lad dokumentationen vende tilbage til essensen, lad skrivningen vende tilbage til roen.
30
+
31
+ For det første vil jeg ikke være bibliotekar. Nogle gange vil jeg skrive noget ned, men jeg har måske ikke tænkt på en titel endnu, eller organiseret det særligt godt. Jeg ønsker, at LLM automatisk vil hjælpe mig med at generere titler, lave resuméer, kategorisere, navigere og andre organisatoriske opgaver.
32
+
33
+ For det andet skal mit skrivebord være rent og ryddeligt. Jeg vil ikke have komplekse konfigurationsværktøjer, rode med indviklede dokumentationsopsætninger eller komplicerede strukturer. Hver gang jeg ser konfigurationsfiler og projektstrukturer fra værktøjer som Docusaurus, VuePress eller Astro, får jeg hovedpine. Nu vælger ZEN at skjule al konfiguration i `.zen`-mappen, feje den ind i et hjørne. Brugeren skal kun fokusere på at skrive indhold, resten håndterer ZEN. Alle andre mapper er dit skriveområde, hvor du frit kan organisere dine Markdown-filer.
34
+
35
+ - Tilbage til modersmålet: Skriv på modersmål, byg flersprogede versioner problemfrit
36
+
37
+ Livet er for kort til at jeg gider oversætte. Man udtrykker sine tanker bedst, når man bruger sit modersmål. Men samtidig er det nødvendigt at forbinde sig med verden, og jeg vil ikke opgive flersproget kommunikation. Derfor ønsker jeg et værktøj, der lader mig skrive på mit modersmål, samtidig med at det gør mit indhold tilgængeligt for flere. Nuværende i18n-løsninger kræver, at man selv oversætter og vedligeholder opdateringer, hvilket er for besværligt. Jeg vælger at bruge LLM til at hjælpe mig med oversættelsen, hvilket sparer mig for meget tid og gør det muligt at fuldføre oversættelser til flere sprog med et enkelt klik.
38
+
39
+ ## Hurtig start
40
+
41
+ Forudsætninger:
42
+
43
+ - [Node.js](https://nodejs.org/) er installeret (anbefalet version 18 eller nyere, skal have `npx`-kommandoen)
44
+ - Du har en [OpenAI API-nøgle](https://platform.openai.com/account/api-keys), eller en OPENAI-kompatibel API-nøgle
45
+ - Git er installeret (bruges til at liste Markdown-filer fra et Git-repository og ignorere filer filtreret af `.gitignore`-regler)
46
+
47
+ Først, arbejd i en mappe, der allerede er styret af Git:
48
+
49
+ Konfigurer miljøvariabler
50
+
51
+ ```bash
52
+ export OPENAI_API_KEY="sk-xxxxxx" # Påkrævet: Erstat med din OpenAI API-nøgle
53
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # Valgfri, bruger OpenAIs officielle API som standard
54
+ export OPENAI_MODEL="gpt-3.5-turbo" # Valgfri, bruger gpt-3.5-turbo-modellen som standard
55
+ ```
56
+
57
+ Byg sitet, understøtter flersproget oversættelse. Bruger den aktuelle mappe som kildemappe og output til `.zen/dist`-mappen.
58
+
59
+ - Du kan angive de sprogversioner, der skal genereres, ved gentagne gange at bruge `--lang`-parameteren (f.eks. `--lang zh-Hans --lang en-US`).
60
+ - Du kan angive det grundlæggende URL-præfiks for sitet med `--base-url`-parameteren (f.eks. dit repositorienavn på GitHub Pages).
61
+ - Kilde-sproget behøver ikke konfigureres, ZEN detekterer det automatisk.
62
+
63
+ ```bash
64
+ npx zengen@latest build --lang zh-Hans --lang en-US
65
+ ```
66
+
67
+ **Se flere parametre eller få hjælp**:
68
+
69
+ ```bash
70
+ npx zengen@latest
71
+ ```
@@ -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.
@@ -0,0 +1,71 @@
1
+ ---
2
+ title: ZEN - Minimalistischer Markdown + AI Static Site Builder
3
+ summary: ZEN ist ein statischer Site-Generator mit KI-Unterstützung, der intelligente Kategorienavigation und automatische inkrementelle Übersetzung bietet. Er ermöglicht es Nutzern, sich auf das Schreiben in ihrer Muttersprache zu konzentrieren und vereinfacht Konfiguration und Build-Prozess.
4
+ tags:
5
+ - Static Site Generator
6
+ - Markdown
7
+ - AI
8
+ - Mehrsprachige Übersetzung
9
+ - Minimalismus
10
+ - Dokumentationstool
11
+ - Node.js
12
+ inferred_lang: de-DE
13
+ ---
14
+
15
+ # ZEN - Minimalistischer Markdown + AI Static Site Builder
16
+
17
+ [> Website Demo](https://zccz14.github.io/ZEN/)
18
+
19
+ ## Grundlegende Funktionen
20
+
21
+ 1. 📃 **Statische Site-Generierung**: Erstellt aus einem beliebigen Git-Ordner mit Markdown-Dateien eine statische HTML-Website.
22
+ 2. 🧭 **Intelligente Kategorienavigation**: Nutzt KI zur Inhaltsanalyse, um eine Sitemap und Navigation zu generieren. Die Position der Quelldateien ist irrelevant.
23
+ 3. 🌍 **Automatische inkrementelle Übersetzung**: Nutzt KI für inkrementelle Übersetzungen. Nutzer können in ihrer Muttersprache schreiben, aber die Zielgruppe kann mehrsprachig sein.
24
+
25
+ Warum noch ein weiterer Markdown Static Site Generator? Ich habe überlegt, wie Dokumentationstools im KI-Zeitalter Autoren besser dienen können:
26
+
27
+ - Zurück zum Inhalt: Minimale Ablenkung, Fokus auf das Schreiben
28
+
29
+ Lasst die Dokumentation zu ihrem Wesen zurückkehren und das Schreiben zur Ruhe.
30
+
31
+ Erstens: Ich möchte kein Bibliothekar sein. Manchmal möchte ich etwas aufschreiben, habe aber vielleicht noch keinen Titel oder eine klare Struktur. Ich möchte, dass eine LLM automatisch Titel generiert, Zusammenfassungen erstellt, kategorisiert, navigiert und andere organisatorische Aufgaben übernimmt.
32
+
33
+ Zweitens: Mein Arbeitsbereich muss aufgeräumt sein. Ich möchte keine komplexen Build-Tools konfigurieren, mich nicht mit komplizierten Dokumenteneinstellungen herumschlagen oder komplexe Strukturen haben. Jedes Mal, wenn ich die Konfigurationsdateien und Projektstrukturen von Tools wie Docusaurus, VuePress oder Astro sehe, bekomme ich Kopfschmerzen. ZEN versteckt nun alle Konfigurationen im `.zen`-Verzeichnis, schiebt sie in die Ecke. Der Nutzer kann sich ganz auf den Inhalt konzentrieren, den Rest erledigt ZEN. Alle anderen Verzeichnisse sind Ihr Schreibbereich, Sie können Ihre Markdown-Dateien frei organisieren.
34
+
35
+ - Zurück zur Muttersprache: In der Muttersprache schreiben, nahtlos mehrsprachige Versionen erstellen
36
+
37
+ Das Leben ist zu kurz für Übersetzungen. Man denkt am tiefsten in seiner Muttersprache. Gleichzeitig ist die Verbindung zur Welt notwendig, ich möchte den mehrsprachigen Austausch nicht aufgeben. Daher wünsche ich mir ein Tool, mit dem ich in meiner Muttersprache schreiben kann, während mehr Menschen meinen Inhalt sehen können. Aktuelle i18n-Lösungen erfordern nicht nur eigene Übersetzungen, sondern auch die Pflege von Aktualisierungen – zu umständlich. Ich nutze LLMs für Übersetzungen, das spart viel Zeit und mehrsprachige Übersetzungen sind mit einem Klick erledigt.
38
+
39
+ ## Schnellstart
40
+
41
+ Voraussetzungen:
42
+
43
+ - [Node.js](https://nodejs.org/) installiert (empfohlen Version 18 oder höher, `npx`-Befehl benötigt)
44
+ - [OpenAI API Key](https://platform.openai.com/account/api-keys) oder kompatibler API-Key beschafft
45
+ - Git installiert (um Markdown-Dateien aus Git aufzulisten und durch `.gitignore` gefilterte Dateien zu ignorieren)
46
+
47
+ Arbeiten Sie zunächst in einem von Git verwalteten Ordner:
48
+
49
+ Umgebungsvariablen konfigurieren
50
+
51
+ ```bash
52
+ export OPENAI_API_KEY="sk-xxxxxx" # Erforderlich: Bitte durch Ihren OpenAI API Key ersetzen
53
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # Optional, standardmäßig wird die offizielle OpenAI API verwendet
54
+ export OPENAI_MODEL="gpt-3.5-turbo" # Optional, standardmäßig wird das gpt-3.5-turbo Modell verwendet
55
+ ```
56
+
57
+ Site erstellen, mit Unterstützung für mehrsprachige Übersetzung. Nutzt das aktuelle Verzeichnis als Quellverzeichnis und gibt in `.zen/dist` aus.
58
+
59
+ - Mehrere Sprachversionen können durch wiederholte Verwendung des `--lang`-Parameters angegeben werden (z.B. `--lang de-DE --lang en-US`).
60
+ - Die Basis-URL-Präfix der Site kann mit dem `--base-url`-Parameter angegeben werden (z.B. der Repository-Name auf GitHub Pages).
61
+ - Die Quellsprache muss nicht konfiguriert werden, ZEN erkennt sie automatisch.
62
+
63
+ ```bash
64
+ npx zengen@latest build --lang de-DE --lang en-US
65
+ ```
66
+
67
+ **Weitere Parameter oder Hilfe anzeigen**:
68
+
69
+ ```bash
70
+ npx zengen@latest
71
+ ```