zengen 0.2.4 → 0.2.6

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 (106) hide show
  1. package/.zen/meta.json +27 -18
  2. package/.zen/src/ar-SA/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +36 -36
  3. package/.zen/src/ar-SA/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  4. package/.zen/src/da-DK/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +29 -29
  5. package/.zen/src/da-DK/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  6. package/.zen/src/de-DE/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +24 -24
  7. package/.zen/src/de-DE/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  8. package/.zen/src/en-US/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +27 -27
  9. package/.zen/src/en-US/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  10. package/.zen/src/es-ES/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +34 -34
  11. package/.zen/src/es-ES/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  12. package/.zen/src/es-MX/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +31 -31
  13. package/.zen/src/es-MX/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  14. package/.zen/src/fi-FI/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +30 -30
  15. package/.zen/src/fi-FI/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  16. package/.zen/src/fr-FR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +26 -26
  17. package/.zen/src/fr-FR/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  18. package/.zen/src/hi-IN/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +29 -29
  19. package/.zen/src/hi-IN/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  20. package/.zen/src/id-ID/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +27 -27
  21. package/.zen/src/id-ID/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  22. package/.zen/src/it-IT/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +38 -38
  23. package/.zen/src/it-IT/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  24. package/.zen/src/ja-JP/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +27 -27
  25. package/.zen/src/ja-JP/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  26. package/.zen/src/ko-KR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +25 -25
  27. package/.zen/src/ko-KR/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  28. package/.zen/src/nl-NL/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +31 -31
  29. package/.zen/src/nl-NL/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  30. package/.zen/src/no-NO/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +32 -32
  31. package/.zen/src/no-NO/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  32. package/.zen/src/pl-PL/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +27 -27
  33. package/.zen/src/pl-PL/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  34. package/.zen/src/pt-BR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +34 -34
  35. package/.zen/src/pt-BR/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  36. package/.zen/src/pt-PT/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +28 -28
  37. package/.zen/src/pt-PT/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  38. package/.zen/src/ru-RU/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +37 -37
  39. package/.zen/src/ru-RU/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  40. package/.zen/src/sv-SE/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +29 -29
  41. package/.zen/src/sv-SE/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  42. package/.zen/src/th-TH/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +30 -30
  43. package/.zen/src/th-TH/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  44. package/.zen/src/tr-TR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +31 -31
  45. package/.zen/src/tr-TR/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  46. package/.zen/src/uk-UA/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +30 -30
  47. package/.zen/src/uk-UA/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  48. package/.zen/src/vi-VN/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +24 -24
  49. package/.zen/src/vi-VN/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
  50. package/.zen/src/zh-Hans/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +14 -11
  51. package/.zen/src/zh-Hans/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +31 -0
  52. package/.zen/src/zh-Hant/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +18 -15
  53. package/.zen/src/zh-Hant/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +31 -0
  54. package/assets/templates/default/layout.html +8 -5
  55. package/dist/ai/extractMetadataFromMarkdown.js +3 -3
  56. package/dist/ai/extractMetadataFromMarkdown.js.map +1 -1
  57. package/dist/process/scanSourceFiles.d.ts.map +1 -1
  58. package/dist/process/scanSourceFiles.js +6 -0
  59. package/dist/process/scanSourceFiles.js.map +1 -1
  60. package/dist/process/template.js +8 -6
  61. package/dist/process/template.js.map +1 -1
  62. package/dist/utils/frontmatter.js +1 -1
  63. package/dist/utils/frontmatter.js.map +1 -1
  64. package/docs/tricks.md +15 -0
  65. package/package.json +1 -1
  66. package/src/ai/extractMetadataFromMarkdown.ts +3 -3
  67. package/src/process/scanSourceFiles.ts +8 -0
  68. package/src/process/template.ts +10 -10
  69. package/src/utils/frontmatter.ts +1 -1
  70. package/.github/workflows/version.yml +0 -88
  71. package/.zen/src/de-DE/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
  72. package/.zen/src/de-DE/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
  73. package/.zen/src/en-US/01d04f7c17b4a541ead9d759d877b30b403e15b849182a49eb1f62bd29ecd18c.md +0 -120
  74. package/.zen/src/en-US/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
  75. package/.zen/src/en-US/1b798c44a4f353e47296ca83d5905e37e6aba3e90bbd9bc3b3d34fc12059a2ca.md +0 -75
  76. package/.zen/src/en-US/1e96be58d76c60056b708eb5bd8b8b81d7b5845d9cfe0b879d85068a5f11df3a.md +0 -189
  77. package/.zen/src/en-US/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
  78. package/.zen/src/en-US/5ec990146b35e00de2630559126ee07f7cdcddeb23b0e8cab3d85b4181353e26.md +0 -53
  79. package/.zen/src/en-US/6124ea88edec5bde737b26b21f71ecfeffe4e73151784856edf813ee231a4baa.md +0 -11
  80. package/.zen/src/en-US/80ae9bed74fc6348a7c1fe9f33e86b65f5d919169721f77bcf0e1bc29fbdb4f9.md +0 -61
  81. package/.zen/src/en-US/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md +0 -63
  82. package/.zen/src/en-US/f0c2799126931ccd113a0c45b1e623870b0d4f4f400becf6dd877da8f1011517.md +0 -40
  83. package/.zen/src/en-US/fdfca9b960d0eaa8b2b96fe988ead7481d2c0b16f66ebc94fb477139b4178cdc.md +0 -65
  84. package/.zen/src/es-ES/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
  85. package/.zen/src/es-ES/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
  86. package/.zen/src/fr-FR/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
  87. package/.zen/src/fr-FR/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
  88. package/.zen/src/ja-JP/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -71
  89. package/.zen/src/ja-JP/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
  90. package/.zen/src/ko-KR/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
  91. package/.zen/src/pt-PT/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
  92. package/.zen/src/pt-PT/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
  93. package/.zen/src/ru-RU/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
  94. package/.zen/src/ru-RU/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
  95. package/.zen/src/zh-Hans/01d04f7c17b4a541ead9d759d877b30b403e15b849182a49eb1f62bd29ecd18c.md +0 -120
  96. package/.zen/src/zh-Hans/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
  97. package/.zen/src/zh-Hans/084ef1f6a0167df8621c673c79211309d4af6c588e7bbe3e043f7c244edd0ac6.md +0 -80
  98. package/.zen/src/zh-Hans/1b798c44a4f353e47296ca83d5905e37e6aba3e90bbd9bc3b3d34fc12059a2ca.md +0 -77
  99. package/.zen/src/zh-Hans/1e96be58d76c60056b708eb5bd8b8b81d7b5845d9cfe0b879d85068a5f11df3a.md +0 -189
  100. package/.zen/src/zh-Hans/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
  101. package/.zen/src/zh-Hans/5ec990146b35e00de2630559126ee07f7cdcddeb23b0e8cab3d85b4181353e26.md +0 -55
  102. package/.zen/src/zh-Hans/6124ea88edec5bde737b26b21f71ecfeffe4e73151784856edf813ee231a4baa.md +0 -11
  103. package/.zen/src/zh-Hans/80ae9bed74fc6348a7c1fe9f33e86b65f5d919169721f77bcf0e1bc29fbdb4f9.md +0 -63
  104. package/.zen/src/zh-Hans/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md +0 -63
  105. package/.zen/src/zh-Hans/f0c2799126931ccd113a0c45b1e623870b0d4f4f400becf6dd877da8f1011517.md +0 -40
  106. package/.zen/src/zh-Hans/fdfca9b960d0eaa8b2b96fe988ead7481d2c0b16f66ebc94fb477139b4178cdc.md +0 -65
@@ -1,73 +0,0 @@
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: zh-Hans
13
- ---
14
-
15
- # ZEN - 简洁的 Markdown 文档站点构建工具
16
-
17
- [简体中文](https://zccz14.github.io/ZEN/zh-Hans) | [English](https://zccz14.github.io/ZEN/en-US)
18
-
19
- 为什么又搞了个 Markdown 静态站点生成器?我重新思考了 AI 时代下,文档工具可以如何更好地服务于写作者:
20
-
21
- - 回归内容:最小化打扰,专注写作
22
-
23
- 让文档回归本质,让写作回归宁静。
24
-
25
- 其一,我不想做图书管理员。我有时想写下一些内容,但我可能还没有想好它的标题,还没有形成特别的组织。我希望 LLM 会自动帮我生成标题、做摘要、分类、导航等整理工作。
26
-
27
- 其二,我的书房必须打扫干净。我不想要配置复杂的构建工具,折腾复杂的文档配置,不喜欢复杂的结构。每次我看到 Docusaurus、VuePress、Astro 这些工具的配置文件和项目结构,我就头疼。现在,ZEN 选择将所有的配置都隐藏到 .zen 目录下,扫到角落里,用户只需要专注于写作内容,其他的交给 ZEN 来处理。其他的目录都是您的写作空间,您可以随意组织您的 Markdown 文件。
28
-
29
- - 回归母语:用母语写作,丝滑构建多语言版本
30
-
31
- 人生苦短,我懒得翻译。人在使用母语时,才是最能发挥自身思考深度的。但同时与世界保持连接又是必要的,我不想放弃多语言的交流。于是我希望有一个工具,能让我用母语写作,同时又能让更多人看到我的内容。现在的 i18n 需要自己翻译不说,还得自己维护内容更新,太麻烦了。我选择使用 LLM 来帮我做翻译,省下了我很多时间,并且可以一键完成多国语言翻译。
32
-
33
- ## 基本功能
34
-
35
- 1. **静态站点生成**
36
- - 将任意一个包含 Markdown 的文件夹构建成一个静态 HTML 站点
37
-
38
- 2. **智能导航**
39
- - 生成站点地图和导航,不需要保持原始的 Markdown 源文件的目录结构,可以随意移动源文件。
40
-
41
- 3. **增量 i18n 翻译**
42
- - 使用 LLM 进行增量 i18n 翻译,让用户使用母语编写 Markdown,但是用户可以是多语言的
43
-
44
- ## 设计理念
45
-
46
- - **极简主义**: 最少的配置,最大的灵活性
47
- - **内容优先**: 专注于写作,而不是工具配置
48
- - **AI 赋能**: 利用 AI 处理翻译和内容组织
49
- - **跨语言**: 支持多语言内容创作和展示
50
-
51
- ## 快速开始
52
-
53
- ### 推荐使用方式
54
-
55
- **推荐用户切换到包含 Markdown 文件的目录下,直接使用以下命令开始构建:**
56
-
57
- ```bash
58
- # 设置环境变量 (根据您的实际情况修改)
59
- export OPENAI_API_KEY="sk-xxxxxx" # 必须:请替换为您的 OpenAI API Key
60
- export OPENAI_BASE_URL="https://api.openai.com/v1" # 可选,默认使用 OpenAI 官方 API
61
- export OPENAI_MODEL="gpt-3.5-turbo" # 可选,默认使用 gpt-3.5-turbo 模型
62
-
63
- # 构建站点,支持多语言翻译
64
- npx zengen@latest build --lang zh-Hans --lang en-US --verbose
65
- ```
66
-
67
- **查看更多参数或帮助**:
68
-
69
- ```bash
70
- npx zengen
71
- ```
72
-
73
- **注意**:ZEN 强制使用当前目录作为源目录,输出到 `.zen/dist` 目录。不支持指定源目录和输出目录参数。
@@ -1,80 +0,0 @@
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: zh-Hans
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
- [Ruсть](https://zccz14.github.io/ZEN/ru-RU) |
21
- [Français](https://zccz14.github.io/ZEN/fr-FR) |
22
- [Deutsch](https://zccz14.github.io/ZEN/de-DE) |
23
- [日本語](https://zccz14.github.io/ZEN/ja-JP) |
24
- [한국어](https://zccz14.github.io/ZEN/ko-KR)
25
-
26
- 为什么又搞了个 Markdown 静态站点生成器?我重新思考了 AI 时代下,文档工具可以如何更好地服务于写作者:
27
-
28
- - 回归内容:最小化打扰,专注写作
29
-
30
- 让文档回归本质,让写作回归宁静。
31
-
32
- 其一,我不想做图书管理员。我有时想写下一些内容,但我可能还没有想好它的标题,还没有形成特别的组织。我希望 LLM 会自动帮我生成标题、做摘要、分类、导航等整理工作。
33
-
34
- 其二,我的书房必须打扫干净。我不想要配置复杂的构建工具,折腾复杂的文档配置,不喜欢复杂的结构。每次我看到 Docusaurus、VuePress、Astro 这些工具的配置文件和项目结构,我就头疼。现在,ZEN 选择将所有的配置都隐藏到 .zen 目录下,扫到角落里,用户只需要专注于写作内容,其他的交给 ZEN 来处理。其他的目录都是您的写作空间,您可以随意组织您的 Markdown 文件。
35
-
36
- - 回归母语:用母语写作,丝滑构建多语言版本
37
-
38
- 人生苦短,我懒得翻译。人在使用母语时,才是最能发挥自身思考深度的。但同时与世界保持连接又是必要的,我不想放弃多语言的交流。于是我希望有一个工具,能让我用母语写作,同时又能让更多人看到我的内容。现在的 i18n 需要自己翻译不说,还得自己维护内容更新,太麻烦了。我选择使用 LLM 来帮我做翻译,省下了我很多时间,并且可以一键完成多国语言翻译。
39
-
40
- ## 基本功能
41
-
42
- 1. **静态站点生成**
43
- - 将任意一个包含 Markdown 的文件夹构建成一个静态 HTML 站点
44
-
45
- 2. **智能导航**
46
- - 生成站点地图和导航,不需要保持原始的 Markdown 源文件的目录结构,可以随意移动源文件。
47
-
48
- 3. **增量 i18n 翻译**
49
- - 使用 LLM 进行增量 i18n 翻译,让用户使用母语编写 Markdown,但是用户可以是多语言的
50
-
51
- ## 设计理念
52
-
53
- - **极简主义**: 最少的配置,最大的灵活性
54
- - **内容优先**: 专注于写作,而不是工具配置
55
- - **AI 赋能**: 利用 AI 处理翻译和内容组织
56
- - **跨语言**: 支持多语言内容创作和展示
57
-
58
- ## 快速开始
59
-
60
- ### 推荐使用方式
61
-
62
- **推荐用户切换到包含 Markdown 文件的目录下,直接使用以下命令开始构建:**
63
-
64
- ```bash
65
- # 设置环境变量 (根据您的实际情况修改)
66
- export OPENAI_API_KEY="sk-xxxxxx" # 必须:请替换为您的 OpenAI API Key
67
- export OPENAI_BASE_URL="https://api.openai.com/v1" # 可选,默认使用 OpenAI 官方 API
68
- export OPENAI_MODEL="gpt-3.5-turbo" # 可选,默认使用 gpt-3.5-turbo 模型
69
-
70
- # 构建站点,支持多语言翻译
71
- npx zengen@latest build --lang zh-Hans --lang en-US --verbose
72
- ```
73
-
74
- **查看更多参数或帮助**:
75
-
76
- ```bash
77
- npx zengen
78
- ```
79
-
80
- **注意**:ZEN 强制使用当前目录作为源目录,输出到 `.zen/dist` 目录。不支持指定源目录和输出目录参数。
@@ -1,77 +0,0 @@
1
- ---
2
- title: ZEN - Markdown 文档站点构建工具
3
- summary:
4
- ZEN 是一个极简的静态站点生成工具,专注于将 Markdown 文件夹构建为 HTML 站点,支持智能导航和 AI
5
- 驱动的增量翻译,强调内容优先和跨语言支持,无需复杂配置。
6
- tags:
7
- - Markdown
8
- - 静态站点生成
9
- - AI 翻译
10
- - 极简主义
11
- - 多语言
12
- - 文档工具
13
- - ZEN
14
- inferred_lang: zh-Hans
15
- ---
16
-
17
- # ZEN - 简洁的 Markdown 文档站点构建工具
18
-
19
- > 📖 **阅读提示**: 本 README 为中文版本。英文版本将由 AI 自动翻译生成。
20
-
21
- ## 项目初衷
22
-
23
- ### 回归内容
24
-
25
- 我喜欢沉思,但不想要配置复杂的构建工具,折腾复杂的文档配置,不喜欢复杂的结构。
26
-
27
- ### 回归母语
28
-
29
- 生命苦短,我用 AI 翻译。与世界保持连接。
30
-
31
- ## 基本功能
32
-
33
- 1. **静态站点生成**
34
- - 将任意一个包含 Markdown 的文件夹构建成一个静态 HTML 站点
35
-
36
- 2. **智能导航**
37
- - 生成站点地图和导航,不需要保持原始的 Markdown 源文件的目录结构
38
-
39
- 3. **增量 i18n 翻译**
40
- - 使用 LLM 进行增量 i18n 翻译,让用户使用母语编写 Markdown,但是用户可以是多语言的
41
-
42
- ## 设计理念
43
-
44
- - **极简主义**: 最少的配置,最大的灵活性
45
- - **内容优先**: 专注于写作,而不是工具配置
46
- - **AI 赋能**: 利用 AI 处理翻译和内容组织
47
- - **跨语言**: 支持多语言内容创作和展示
48
-
49
- ## 快速开始
50
-
51
- ### 推荐使用方式
52
-
53
- **推荐用户切换到包含 Markdown 文件的目录下,直接使用以下命令开始构建:**
54
-
55
- ```bash
56
- npx zengen build
57
- ```
58
-
59
- ### 其他用法
60
-
61
- 1. **实时预览(监听文件变化)**:
62
-
63
- ```bash
64
- npx zengen build --watch
65
- ```
66
-
67
- 2. **查看更多参数或帮助**:
68
-
69
- ```bash
70
- npx zengen
71
- ```
72
-
73
- **注意**:ZEN 强制使用当前目录作为源目录,输出到 `.zen/dist` 目录。不再支持指定源目录和输出目录参数。
74
-
75
- ---
76
-
77
- **ZEN** - 让文档回归本质,让写作回归宁静。
@@ -1,189 +0,0 @@
1
- ---
2
- title: ZEN 文档站点最佳实践
3
- summary: 本文档介绍了使用 ZEN 构建文档站点的最佳实践,涵盖多语言管理、性能优化、部署策略、维护建议、常见问题解决方案和高级技巧,旨在帮助用户高效开发和维护文档。
4
- tags:
5
- - ZEN
6
- - 文档站点
7
- - 最佳实践
8
- - 性能优化
9
- - 部署策略
10
- - 多语言管理
11
- - 维护建议
12
- inferred_lang: zh-Hans
13
- ---
14
-
15
- # 最佳实践
16
-
17
- 本文档介绍使用 ZEN 构建文档站点的最佳实践。
18
-
19
- ## 多语言管理
20
-
21
- ### 翻译策略
22
-
23
- 1. **主语言优先**: 先用母语完整编写文档
24
- 2. **增量翻译**: 每次更新后只翻译修改部分
25
- 3. **术语一致**: 建立术语表保持翻译一致性
26
- 4. **人工校对**: AI 翻译后建议人工校对
27
-
28
- ## 性能优化
29
-
30
- ### 构建优化
31
-
32
- 1. **增量构建**: 使用 `--watch` 模式开发
33
- 2. **缓存利用**: ZEN 会自动缓存处理结果
34
- 3. **并行处理**: 多核 CPU 自动并行处理文件
35
-
36
- ### 开发工作流
37
-
38
- ```bash
39
- # 开发时监听变化
40
- cd docs
41
- npx zengen build --watch
42
-
43
- # 启动开发服务器
44
- npx zengen build --watch --serve
45
-
46
- # 生产构建
47
- npx zengen build
48
- ```
49
-
50
- ## 部署策略
51
-
52
- ### CI/CD 集成
53
-
54
- #### GitHub Actions 示例
55
-
56
- ```yaml
57
- name: Build and Deploy Documentation
58
- on:
59
- push:
60
- branches: [main]
61
- paths:
62
- - 'docs/**'
63
- - '.github/workflows/docs.yml'
64
-
65
- jobs:
66
- build:
67
- runs-on: ubuntu-latest
68
- steps:
69
- - name: Checkout repository
70
- uses: actions/checkout@v4
71
-
72
- - name: Setup Node.js
73
- uses: actions/setup-node@v4
74
- with:
75
- node-version: '20.x'
76
-
77
- - name: Build documentation
78
- run: |
79
- cd docs
80
- npx zengen build --base-url /my-docs
81
-
82
- - name: Deploy to GitHub Pages
83
- uses: peaceiris/actions-gh-pages@v3
84
- with:
85
- github_token: ${{ secrets.GITHUB_TOKEN }}
86
- publish_dir: docs/.zen/dist
87
- ```
88
-
89
- #### 自定义部署脚本
90
-
91
- ```bash
92
- #!/bin/bash
93
- # deploy-docs.sh
94
-
95
- # 切换到文档目录
96
- cd docs
97
-
98
- # 构建文档
99
- npx zengen build
100
-
101
- # 同步到服务器
102
- rsync -avz .zen/dist/ user@server:/var/www/docs/
103
-
104
- # 清理缓存
105
- rm -rf .zen/cache
106
- ```
107
-
108
- ### 云部署选项
109
-
110
- - **GitHub Pages**: 免费托管文档
111
- - **Vercel**: 自动部署静态站点
112
- - **Netlify**: 支持表单处理和重定向
113
- - **AWS S3 + CloudFront**: 企业级静态托管
114
-
115
- ## 维护建议
116
-
117
- ### 定期更新
118
-
119
- 1. **内容审核**: 每月检查文档准确性
120
- 2. **链接检查**: 定期检查死链
121
- 3. **性能监控**: 监控页面加载速度
122
- 4. **用户反馈**: 收集用户反馈改进文档
123
-
124
- ### 版本控制
125
-
126
- 1. **文档版本化**: 与软件版本同步
127
- 2. **变更日志**: 记录文档更新历史
128
- 3. **回滚机制**: 支持快速回滚到旧版本
129
-
130
- ## 常见问题
131
-
132
- ### 构建速度慢
133
-
134
- **解决方案:**
135
-
136
- - 减少不必要的图片和资源
137
- - 使用 `--watch` 模式进行增量开发
138
- - 拆分大型文档为多个小文件
139
- - 禁用不需要的处理器
140
-
141
- ### 翻译质量不高
142
-
143
- **解决方案:**
144
-
145
- - 提供上下文给 AI 翻译
146
- - 建立术语表提高一致性
147
- - 人工校对关键内容
148
- - 调整翻译提示词
149
-
150
- ### 导航结构复杂
151
-
152
- **解决方案:**
153
-
154
- - 保持扁平化目录结构
155
- - 使用清晰的标题层级
156
- - 提供搜索功能
157
- - 合理使用侧边栏导航
158
-
159
- ### 内存使用过高
160
-
161
- **解决方案:**
162
-
163
- - 减少同时处理的文件数量
164
- - 禁用缓存(不推荐)
165
- - 增加系统内存
166
- - 分批处理大型文档
167
-
168
- ## 高级技巧
169
-
170
- ### 自定义模板技巧
171
-
172
- 1. **响应式设计**: 确保模板在移动设备上正常显示
173
- 2. **主题切换**: 实现深色/浅色主题
174
- 3. **代码高亮**: 集成 highlight.js 或其他高亮库
175
- 4. **搜索功能**: 添加客户端搜索
176
-
177
- ### 集成其他工具
178
-
179
- 1. **图片优化**: 使用 sharp 或 imagemin 优化图片
180
- 2. **SEO 优化**: 添加 meta 标签和结构化数据
181
- 3. **分析集成**: 集成 Google Analytics 或 Plausible
182
- 4. **CDN 加速**: 使用 CDN 加速静态资源
183
-
184
- ### 监控和日志
185
-
186
- 1. **构建日志**: 使用 `--verbose` 查看详细日志
187
- 2. **错误监控**: 设置错误监控和告警
188
- 3. **性能监控**: 监控构建时间和资源使用
189
- 4. **用户分析**: 分析文档使用情况
@@ -1,81 +0,0 @@
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: zh-Hans
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` 目录。不支持指定源目录和输出目录参数。
@@ -1,55 +0,0 @@
1
- ---
2
- title: ZEN 高级用法指南
3
- summary:
4
- 本文档介绍了 ZEN 的高级功能,包括自定义 HTML 模板、配置选项(如源目录、输出目录、模板、基础 URL
5
- 和多语言支持)以及插件系统,帮助用户扩展和定制 ZEN 工具。
6
- tags:
7
- - ZEN
8
- - 高级用法
9
- - 自定义模板
10
- - 配置选项
11
- - 插件系统
12
- - 文档生成
13
- - 多语言支持
14
- inferred_lang: zh-Hans
15
- ---
16
-
17
- # 高级用法
18
-
19
- 深入介绍 ZEN 的高级功能和配置选项。
20
-
21
- ## 自定义模板
22
-
23
- ZEN 支持自定义 HTML 模板:
24
-
25
- ```bash
26
- zengen build --src ./docs --out ./dist --template ./custom-template.html
27
- ```
28
-
29
- ## 配置选项
30
-
31
- 可以在 `.zenrc` 文件中配置:
32
-
33
- ```json
34
- {
35
- "srcDir": "./docs",
36
- "outDir": "./dist",
37
- "template": "./template.html",
38
- "baseUrl": "https://example.com",
39
- "i18n": {
40
- "sourceLang": "zh-Hans",
41
- "targetLangs": ["en-US", "ja-JP"]
42
- }
43
- }
44
- ```
45
-
46
- ## 插件系统
47
-
48
- ZEN 支持插件扩展功能:
49
-
50
- ```typescript
51
- interface MarkdownProcessor {
52
- beforeParse?(content: string, fileInfo: FileInfo): string | Promise<string>;
53
- afterParse?(html: string, fileInfo: FileInfo): string | Promise<string>;
54
- }
55
- ```
@@ -1,11 +0,0 @@
1
- ---
2
- title: 测试文档
3
- summary: 这是一个测试文档,内容为空,仅包含标题。
4
- tags:
5
- - 测试
6
- - 文档
7
- - 示例
8
- inferred_lang: zh-CN
9
- ---
10
-
11
- # 测试文档
@@ -1,63 +0,0 @@
1
- ---
2
- title: ZEN 配置指南
3
- summary:
4
- 本文档介绍了 ZEN 工具的配置和使用方法,包括基本命令如构建文档、实时预览和启动开发服务器,以及命令行选项如 --watch、--serve
5
- 和 --port 的详细说明。
6
- tags:
7
- - ZEN
8
- - 配置指南
9
- - 命令行
10
- - 文档构建
11
- - 开发服务器
12
- - 极简主义
13
- inferred_lang: zh-Hans
14
- ---
15
-
16
- # 配置指南
17
-
18
- ZEN 的设计理念是极简主义,因此配置非常简单。
19
-
20
- ## 命令行使用
21
-
22
- ### 基本命令
23
-
24
- ```bash
25
- # 构建文档(推荐使用方式)
26
- npx zengen build
27
-
28
- # 实时预览(监听文件变化)
29
- npx zengen build --watch
30
-
31
- # 启动开发服务器(需要 --watch)
32
- npx zengen build --watch --serve
33
-
34
- # 自定义端口
35
- npx zengen build --watch --serve --port 8080
36
-
37
- # 显示详细日志
38
- npx zengen build --verbose
39
-
40
- # 设置基础 URL
41
- npx zengen build --base-url /my-docs
42
-
43
- # 查看帮助
44
- npx zengen
45
- ```
46
-
47
- **重要说明:**
48
-
49
- - ZEN 强制使用当前目录作为源目录,输出到 `.zen/dist` 目录
50
- - 不再支持通过命令行参数指定源目录和输出目录
51
- - 使用 `--watch` 模式时,修改文件会自动重建
52
-
53
- ### 命令行选项
54
-
55
- | 选项 | 简写 | 描述 | 默认值 |
56
- | ------------ | ---- | -------------------------------- | ----------- |
57
- | `--watch` | `-w` | 监听文件变化并自动重建 | `false` |
58
- | `--serve` | `-s` | 启动开发服务器(需要 `--watch`) | `false` |
59
- | `--port` | `-p` | 开发服务器端口 | `3000` |
60
- | `--host` | | 开发服务器主机 | `localhost` |
61
- | `--verbose` | `-v` | 显示详细日志 | `false` |
62
- | `--base-url` | | 站点基础 URL | 无 |
63
- | `--help` | `-h` | 显示帮助信息 | 无 |
@@ -1,63 +0,0 @@
1
- ---
2
- title: ZEN - Markdown 文档站点构建工具
3
- summary: ZEN 是一个极简的 Markdown 静态站点生成工具,强调内容优先,通过隐藏配置和 AI 赋能,让用户专注于母语写作,并支持多语言翻译和智能导航。
4
- tags:
5
- - Markdown
6
- - 静态站点生成
7
- - AI 翻译
8
- - 多语言
9
- - 极简主义
10
- - 内容优先
11
- - 文档工具
12
- inferred_lang: zh-Hans
13
- ---
14
-
15
- # ZEN - 简洁的 Markdown 文档站点构建工具
16
-
17
- [简体中文](https://zccz14.github.io/ZEN/zh-Hans) | [English](https://zccz14.github.io/ZEN/en-US)
18
-
19
- 为什么又搞了个 Markdown 静态站点生成器?
20
-
21
- - 回归内容:最小化打扰,让您专注写作
22
-
23
- 让文档回归本质,让写作回归宁静。我不想要配置复杂的构建工具,折腾复杂的文档配置,不喜欢复杂的结构。每次我看到 Docusaurus、VuePress、Astro 这些工具的配置文件和项目结构,我就头疼。现在,ZEN 选择将所有的配置都隐藏到 .zen 目录下,扫到角落里,用户只需要专注于写作内容,其他的交给 ZEN 来处理。其他的目录都是您的写作空间,您可以随意组织您的 Markdown 文件。LLM 还会自动帮您生成标题、做摘要、分类、生成导航等工作。您真的只需要专注于写作。
24
-
25
- - 回归母语:仅用母语写作,丝滑构建多语言版本
26
-
27
- 人生苦短,我懒得翻译。人在使用母语时,才是最能发挥自身思考深度的。但同时与世界保持连接又是必要的,我不想放弃多语言的交流。于是我希望有一个工具,能让我用母语写作,同时又能让更多人看到我的内容。现在的 i18n 需要自己翻译不说,还得自己维护内容更新,太麻烦了。我选择使用 LLM 来帮我做翻译,省下了我很多时间,并且可以一键完成多国语言翻译。
28
-
29
- ## 基本功能
30
-
31
- 1. **静态站点生成**
32
- - 将任意一个包含 Markdown 的文件夹构建成一个静态 HTML 站点
33
-
34
- 2. **智能导航**
35
- - 生成站点地图和导航,不需要保持原始的 Markdown 源文件的目录结构
36
-
37
- 3. **增量 i18n 翻译**
38
- - 使用 LLM 进行增量 i18n 翻译,让用户使用母语编写 Markdown,但是用户可以是多语言的
39
-
40
- ## 设计理念
41
-
42
- - **极简主义**: 最少的配置,最大的灵活性
43
- - **内容优先**: 专注于写作,而不是工具配置
44
- - **AI 赋能**: 利用 AI 处理翻译和内容组织
45
- - **跨语言**: 支持多语言内容创作和展示
46
-
47
- ## 快速开始
48
-
49
- ### 推荐使用方式
50
-
51
- **推荐用户切换到包含 Markdown 文件的目录下,直接使用以下命令开始构建:**
52
-
53
- ```bash
54
- npx zengen build
55
- ```
56
-
57
- **查看更多参数或帮助**:
58
-
59
- ```bash
60
- npx zengen
61
- ```
62
-
63
- **注意**:ZEN 强制使用当前目录作为源目录,输出到 `.zen/dist` 目录。不支持指定源目录和输出目录参数。