zengen 0.2.1 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. package/.github/workflows/pages.yml +7 -4
  2. package/.zen/meta.json +40 -118
  3. package/.zen/src/ar-SA/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  4. package/.zen/src/da-DK/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  5. package/.zen/src/de-DE/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  6. package/.zen/src/de-DE/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  7. package/.zen/src/de-DE/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  8. package/.zen/src/en-US/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  9. package/.zen/src/en-US/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  10. package/.zen/src/en-US/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  11. package/.zen/src/en-US/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md +63 -0
  12. package/.zen/src/es-ES/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  13. package/.zen/src/es-ES/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  14. package/.zen/src/es-ES/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  15. package/.zen/src/es-MX/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  16. package/.zen/src/fi-FI/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  17. package/.zen/src/fr-FR/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  18. package/.zen/src/fr-FR/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  19. package/.zen/src/fr-FR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  20. package/.zen/src/hi-IN/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  21. package/.zen/src/id-ID/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  22. package/.zen/src/it-IT/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  23. package/.zen/src/ja-JP/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +71 -0
  24. package/.zen/src/ja-JP/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  25. package/.zen/src/ja-JP/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  26. package/.zen/src/ko-KR/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  27. package/.zen/src/ko-KR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  28. package/.zen/src/nl-NL/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  29. package/.zen/src/no-NO/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  30. package/.zen/src/pl-PL/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  31. package/.zen/src/pt-BR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  32. package/.zen/src/pt-PT/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  33. package/.zen/src/pt-PT/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  34. package/.zen/src/pt-PT/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  35. package/.zen/src/ru-RU/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  36. package/.zen/src/ru-RU/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  37. package/.zen/src/ru-RU/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  38. package/.zen/src/sv-SE/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  39. package/.zen/src/th-TH/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  40. package/.zen/src/tr-TR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  41. package/.zen/src/uk-UA/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  42. package/.zen/src/vi-VN/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  43. package/.zen/src/zh-Hans/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
  44. package/.zen/src/zh-Hans/084ef1f6a0167df8621c673c79211309d4af6c588e7bbe3e043f7c244edd0ac6.md +80 -0
  45. package/.zen/src/zh-Hans/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
  46. package/.zen/src/zh-Hans/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  47. package/.zen/src/zh-Hans/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md +63 -0
  48. package/.zen/src/zh-Hant/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
  49. package/README.md +30 -34
  50. package/assets/templates/default/layout.html +58 -3
  51. package/dist/ai/translateMarkdown.d.ts +1 -1
  52. package/dist/ai/translateMarkdown.d.ts.map +1 -1
  53. package/dist/ai/translateMarkdown.js +33 -2
  54. package/dist/ai/translateMarkdown.js.map +1 -1
  55. package/dist/languages.d.ts +2 -0
  56. package/dist/languages.d.ts.map +1 -0
  57. package/dist/languages.js +37 -0
  58. package/dist/languages.js.map +1 -0
  59. package/dist/process/template.js +11 -12
  60. package/dist/process/template.js.map +1 -1
  61. package/package.json +2 -2
  62. package/src/ai/translateMarkdown.ts +33 -2
  63. package/src/languages.ts +37 -0
  64. package/src/process/template.ts +12 -12
  65. package/docs/advanced-usage.md +0 -39
  66. package/docs/deployment/github-pages.md +0 -107
  67. package/docs/getting-started.md +0 -26
  68. package/docs/guides/best-practices.md +0 -175
  69. package/docs/guides/config.md +0 -48
  70. package/docs/guides/index.md +0 -51
  71. package/docs/testing/test-document.md +0 -1
@@ -0,0 +1,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.
@@ -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.
@@ -0,0 +1,71 @@
1
+ ---
2
+ title: ZEN - Minimalist Markdown + AI Static Site Builder
3
+ summary: ZEN is a static site generator integrated with AI, supporting intelligent categorization, navigation, and automatic incremental translation. It allows users to focus on writing in their native language while simplifying configuration and build processes.
4
+ tags:
5
+ - Static Site Generator
6
+ - Markdown
7
+ - AI
8
+ - Multilingual Translation
9
+ - Minimalism
10
+ - Documentation Tool
11
+ - Node.js
12
+ inferred_lang: zh-Hans
13
+ ---
14
+
15
+ # ZEN - Minimalist Markdown + AI Static Site Builder
16
+
17
+ [> Website Demo](https://zccz14.github.io/ZEN/)
18
+
19
+ ## Core Features
20
+
21
+ 1. 📃 **Static Site Generation**: Builds a static HTML site from any git-managed folder containing Markdown files.
22
+ 2. 🧭 **Intelligent Categorization & Navigation**: Uses AI for content analysis to generate a sitemap and navigation, independent of source file locations.
23
+ 3. 🌍 **Automatic Incremental Translation**: Employs AI for incremental translation, allowing users to write Markdown in their native language while supporting multilingual audiences.
24
+
25
+ Why create another Markdown static site generator? I've reconsidered how documentation tools can better serve writers in the AI era:
26
+
27
+ - **Return to Content: Minimize Distractions, Focus on Writing**
28
+
29
+ Let documentation return to its essence and writing to its tranquility.
30
+
31
+ First, I don't want to be a librarian. Sometimes I want to jot down ideas before finalizing titles or organizing them perfectly. I wish LLMs could automatically generate titles, summaries, categories, and navigation for me.
32
+
33
+ Second, my workspace must be clean. I dislike complex build tool configurations, intricate documentation setups, and convoluted structures. Tools like Docusaurus, VuePress, and Astro often give me headaches with their config files and project layouts. ZEN hides all configuration in a `.zen` directory, tucked away in a corner. Users only need to focus on writing content; ZEN handles the rest. All other directories are your writing space, where you can organize Markdown files freely.
34
+
35
+ - **Return to Native Language: Write in Your Mother Tongue, Build Multilingual Versions Smoothly**
36
+
37
+ Life is short; I'm too lazy to translate. People think most deeply in their native language. Yet, connecting with the world is essential, and I don't want to give up multilingual communication. I desire a tool that lets me write in my native language while making my content accessible to a broader audience. Traditional i18n requires manual translation and content update maintenance, which is too cumbersome. I choose to use LLMs for translation, saving significant time and enabling one-click multilingual builds.
38
+
39
+ ## Quick Start
40
+
41
+ Prerequisites:
42
+
43
+ - [Node.js](https://nodejs.org/) installed (version 18 or above recommended, `npx` command required)
44
+ - [OpenAI API Key](https://platform.openai.com/account/api-keys) obtained, or an OPENAI-compatible API Key
45
+ - Git installed (used to list Markdown files from Git, ignoring files filtered by `.gitignore` rules)
46
+
47
+ First, work within a folder already managed by Git:
48
+
49
+ Set environment variables:
50
+
51
+ ```bash
52
+ export OPENAI_API_KEY="sk-xxxxxx" # Required: Replace with your OpenAI API Key
53
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # Optional, defaults to the official OpenAI API
54
+ export OPENAI_MODEL="gpt-3.5-turbo" # Optional, defaults to the gpt-3.5-turbo model
55
+ ```
56
+
57
+ Build the site with support for multilingual translation. Uses the current directory as the source and outputs to the `.zen/dist` directory.
58
+
59
+ - Specify language versions to generate using the `--lang` parameter multiple times (e.g., `--lang zh-Hans --lang en-US`).
60
+ - Specify the site's base URL prefix using the `--base-url` parameter (e.g., the repository name on GitHub Pages).
61
+ - No need to configure the source language; ZEN will auto-detect it.
62
+
63
+ ```bash
64
+ npx zengen@latest build --lang zh-Hans --lang en-US
65
+ ```
66
+
67
+ **View more parameters or help**:
68
+
69
+ ```bash
70
+ npx zengen@latest
71
+ ```
@@ -0,0 +1,63 @@
1
+ ---
2
+ title: ZEN - Markdown Documentation Site Builder
3
+ summary: ZEN is a minimalist Markdown static site generator that emphasizes content-first, hides configuration, and leverages AI to empower users to focus on writing in their native language, while supporting multilingual translation and intelligent navigation.
4
+ tags:
5
+ - Markdown
6
+ - Static Site Generation
7
+ - AI Translation
8
+ - Multilingual
9
+ - Minimalism
10
+ - Content-First
11
+ - Documentation Tool
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?
20
+
21
+ - **Return to Content**: Minimize distractions, let you focus on writing
22
+
23
+ Let documentation return to its essence, let writing return to tranquility. I don't want complex build tools with complicated configurations, I dislike fiddling with intricate documentation setups and convoluted 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 configuration in the `.zen` directory, sweeping it into a corner. Users only need to focus on writing content; ZEN handles the rest. All other directories are your writing space; you can organize your Markdown files however you like. LLMs will automatically help you generate titles, create summaries, categorize, and generate navigation. You really only need to focus on writing.
24
+
25
+ - **Return to Native Language**: Write only in your native language, smoothly build multilingual versions
26
+
27
+ 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 to the world is also 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 also letting more people see my content. Current i18n solutions not only require you to translate yourself but also to maintain content updates, which is too troublesome. I choose to use LLMs to handle translation for me, saving me a lot of time and enabling one-click translation into multiple languages.
28
+
29
+ ## Core Features
30
+
31
+ 1. **Static Site Generation**
32
+ - Build any folder containing Markdown files into a static HTML site.
33
+
34
+ 2. **Intelligent Navigation**
35
+ - Generate site maps and navigation without needing to maintain the original directory structure of the Markdown source files.
36
+
37
+ 3. **Incremental i18n Translation**
38
+ - Use LLMs for incremental i18n translation, allowing users to write Markdown in their native language while the audience can be multilingual.
39
+
40
+ ## Design Philosophy
41
+
42
+ - **Minimalism**: Minimal configuration, maximum flexibility.
43
+ - **Content-First**: Focus on writing, not tool configuration.
44
+ - **AI-Powered**: Leverage AI for translation and content organization.
45
+ - **Cross-Language**: Support multilingual content creation and display.
46
+
47
+ ## Quick Start
48
+
49
+ ### Recommended Usage
50
+
51
+ **It is recommended that users switch to the directory containing their Markdown files and directly use the following command to start building:**
52
+
53
+ ```bash
54
+ npx zengen build
55
+ ```
56
+
57
+ **To view more parameters or help:**
58
+
59
+ ```bash
60
+ npx zengen
61
+ ```
62
+
63
+ **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.
@@ -0,0 +1,73 @@
1
+ ---
2
+ title: ZEN - Herramienta para construir sitios de documentación en Markdown
3
+ summary: ZEN es una herramienta minimalista para generar sitios estáticos a partir de Markdown, centrada en la escritura de contenido. Utiliza IA para gestionar traducciones y navegación, soporta construcción multilingüe y no requiere configuración compleja.
4
+ tags:
5
+ - Markdown
6
+ - Generador de sitios estáticos
7
+ - Traducción por IA
8
+ - Multilingüe
9
+ - Minimalismo
10
+ - Herramienta de documentación
11
+ - ZEN
12
+ inferred_lang: es-ES
13
+ ---
14
+
15
+ # ZEN - Herramienta sencilla para construir sitios de documentación en Markdown
16
+
17
+ [简体中文](https://zccz14.github.io/ZEN/zh-Hans) | [English](https://zccz14.github.io/ZEN/en-US) | [Español](https://zccz14.github.io/ZEN/es-ES)
18
+
19
+ ¿Por qué crear otro generador de sitios estáticos con Markdown? He reconsiderado cómo las herramientas de documentación pueden servir mejor a los escritores en la era de la IA:
20
+
21
+ - **Regreso al contenido**: Minimizar las distracciones, concentrarse en escribir
22
+
23
+ Devolver la esencia a la documentación y la tranquilidad a la escritura.
24
+
25
+ Primero, no quiero ser un bibliotecario. A veces quiero escribir algo, pero quizás aún no he pensado en su título o no he organizado bien las ideas. Me gustaría que una LLM generara automáticamente títulos, resúmenes, categorías, navegación y otras tareas de organización.
26
+
27
+ Segundo, mi estudio debe estar ordenado. No quiero herramientas de construcción con configuraciones complejas, ni lidiar con estructuras complicadas. Cada vez que veo los archivos de configuración y la estructura de proyectos de herramientas como Docusaurus, VuePress o Astro, me duele la cabeza. Ahora, ZEN opta por ocultar toda la configuración en el directorio `.zen`, apartándola a un rincón, para que el usuario solo se centre en escribir el contenido y deje el resto a ZEN. Todos los demás directorios son su espacio de escritura, donde puede organizar sus archivos Markdown como desee.
28
+
29
+ - **Regreso a la lengua materna**: Escribir en la lengua materna, construir versiones multilingües sin esfuerzo
30
+
31
+ La vida es corta, no tengo ganas de traducir. Uno alcanza su máxima profundidad de pensamiento cuando usa su lengua materna. Pero al mismo tiempo, es necesario mantenerse conectado con el mundo; no quiero renunciar a la comunicación multilingüe. Por eso deseo una herramienta que me permita escribir en mi lengua materna y, a la vez, llegar a más personas con mi contenido. Actualmente, la internacionalización (i18n) requiere que uno mismo traduzca y mantenga las actualizaciones del contenido, lo cual es muy tedioso. He optado por usar una LLM para que me ayude con las traducciones, ahorrándome mucho tiempo y permitiéndome completar traducciones a múltiples idiomas con un solo clic.
32
+
33
+ ## Funcionalidades básicas
34
+
35
+ 1. **Generación de sitios estáticos**
36
+ - Convierte cualquier carpeta que contenga archivos Markdown en un sitio web estático HTML.
37
+
38
+ 2. **Navegación inteligente**
39
+ - Genera un mapa del sitio y navegación. No es necesario mantener la estructura de directorios original de los archivos fuente Markdown; puedes mover los archivos fuente libremente.
40
+
41
+ 3. **Traducción incremental i18n**
42
+ - Utiliza LLM para realizar traducciones i18n incrementales, permitiendo a los usuarios escribir Markdown en su lengua materna, pero siendo el resultado multilingüe.
43
+
44
+ ## Filosofía de diseño
45
+
46
+ - **Minimalismo**: Mínima configuración, máxima flexibilidad.
47
+ - **Contenido primero**: Enfocarse en escribir, no en configurar herramientas.
48
+ - **Potenciado por IA**: Utiliza la IA para gestionar traducciones y organización del contenido.
49
+ - **Multilingüe**: Soporta la creación y visualización de contenido en múltiples idiomas.
50
+
51
+ ## Comenzar rápidamente
52
+
53
+ ### Forma recomendada de uso
54
+
55
+ **Se recomienda que el usuario cambie al directorio que contiene los archivos Markdown y utilice directamente el siguiente comando para comenzar la construcción:**
56
+
57
+ ```bash
58
+ # Establecer variables de entorno (modificar según su situación real)
59
+ export OPENAI_API_KEY="sk-xxxxxx" # Obligatorio: reemplazar con su propia clave de API de OpenAI
60
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # Opcional, por defecto usa la API oficial de OpenAI
61
+ export OPENAI_MODEL="gpt-3.5-turbo" # Opcional, por defecto usa el modelo gpt-3.5-turbo
62
+
63
+ # Construir el sitio, soporta traducción multilingüe
64
+ npx zengen@latest build --lang zh-Hans --lang en-US --verbose
65
+ ```
66
+
67
+ **Ver más parámetros o ayuda**:
68
+
69
+ ```bash
70
+ npx zengen
71
+ ```
72
+
73
+ **Nota**: ZEN obliga a usar el directorio actual como directorio fuente y la salida se genera en el directorio `.zen/dist`. No admite parámetros para especificar directorios de origen o de salida.
@@ -0,0 +1,81 @@
1
+ ---
2
+ title: ZEN - Herramienta de construcción de sitios de documentación en Markdown
3
+ summary: ZEN es una herramienta de generación de sitios estáticos en Markdown, sencilla y centrada en el contenido y el minimalismo. Utiliza IA para una navegación inteligente y traducción multilingüe, ayudando a los usuarios a concentrarse en la escritura sin configuraciones complejas.
4
+ tags:
5
+ - Markdown
6
+ - Generación de sitios estáticos
7
+ - Traducción con IA
8
+ - Multilingüe
9
+ - Minimalismo
10
+ - Herramienta de documentación
11
+ - ZEN
12
+ inferred_lang: es-ES
13
+ ---
14
+
15
+ # ZEN - Herramienta de construcción de sitios de documentación en 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
+ ¿Por qué crear otro generador de sitios estáticos en Markdown? He reconsiderado cómo las herramientas de documentación pueden servir mejor a los escritores en la era de la IA:
28
+
29
+ - **Regreso al contenido**: Minimizar las distracciones, concentrarse en escribir
30
+
31
+ Devolver la documentación a su esencia, devolver la escritura a la tranquilidad.
32
+
33
+ Primero, no quiero ser un bibliotecario. A veces quiero escribir algo, pero quizás aún no he pensado en su título, no he formado una organización particular. Espero que la LLM me ayude automáticamente a generar títulos, hacer resúmenes, clasificar, navegar y otras tareas de organización.
34
+
35
+ Segundo, mi estudio debe estar limpio y ordenado. No quiero herramientas de construcción con configuraciones complejas, lidiar con configuraciones de documentos complicadas, ni estructuras complejas. Cada vez que veo los archivos de configuración y la estructura de proyectos de herramientas como Docusaurus, VuePress, Astro, me duele la cabeza. Ahora, ZEN elige ocultar toda la configuración en el directorio `.zen`, barrerla a un rincón. El usuario solo necesita concentrarse en escribir el contenido, y ZEN se encarga del resto. Los demás directorios son su espacio de escritura, puede organizar sus archivos Markdown como desee.
36
+
37
+ - **Regreso a la lengua materna**: Escribir en la lengua materna, construir versiones multilingües de forma fluida
38
+
39
+ La vida es corta, soy demasiado perezoso para traducir. Cuando una persona usa su lengua materna, es cuando puede aprovechar al máximo la profundidad de su pensamiento. Pero al mismo tiempo, mantener la conexión con el mundo es necesario, no quiero renunciar a la comunicación multilingüe. Por eso, deseo una herramienta que me permita escribir en mi lengua materna y, a la vez, permita que más personas vean mi contenido. La i18n actual no solo requiere que uno traduzca por sí mismo, sino que también debe mantener actualizado el contenido, es demasiado engorroso. Elijo usar LLM para ayudarme con la traducción, ahorrándome mucho tiempo y pudiendo completar la traducción a múltiples idiomas con un solo clic.
40
+
41
+ ## Funcionalidades básicas
42
+
43
+ 1. **Generación de sitios estáticos**
44
+ - Convierte cualquier carpeta que contenga archivos Markdown en un sitio HTML estático.
45
+
46
+ 2. **Navegación inteligente**
47
+ - Genera un mapa del sitio y navegación. No es necesario mantener la estructura de directorios original de los archivos fuente Markdown; se pueden mover libremente.
48
+
49
+ 3. **Traducción i18n incremental**
50
+ - Utiliza LLM para realizar traducciones i18n incrementales, permitiendo a los usuarios escribir Markdown en su lengua materna, pero siendo multilingües.
51
+
52
+ ## Filosofía de diseño
53
+
54
+ - **Minimalismo**: Mínima configuración, máxima flexibilidad.
55
+ - **Contenido primero**: Enfocarse en escribir, no en configurar herramientas.
56
+ - **Potenciado por IA**: Utiliza IA para manejar traducciones y organización de contenido.
57
+ - **Multilingüe**: Soporta la creación y visualización de contenido en múltiples idiomas.
58
+
59
+ ## Comenzar rápidamente
60
+
61
+ ### Forma recomendada de uso
62
+
63
+ **Se recomienda que los usuarios cambien al directorio que contiene los archivos Markdown y utilicen directamente el siguiente comando para comenzar la construcción:**
64
+
65
+ ```bash
66
+ # Establecer variables de entorno (modificar según su situación real)
67
+ export OPENAI_API_KEY="sk-xxxxxx" # Obligatorio: reemplazar con su clave API de OpenAI
68
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # Opcional, por defecto usa la API oficial de OpenAI
69
+ export OPENAI_MODEL="gpt-3.5-turbo" # Opcional, por defecto usa el modelo gpt-3.5-turbo
70
+
71
+ # Construir el sitio, soporta traducción multilingüe
72
+ npx zengen@latest build --lang zh-Hans --lang en-US --verbose
73
+ ```
74
+
75
+ **Ver más parámetros o ayuda**:
76
+
77
+ ```bash
78
+ npx zengen
79
+ ```
80
+
81
+ **Nota**: ZEN obliga a usar el directorio actual como directorio fuente y la salida va al directorio `.zen/dist`. No admite parámetros para especificar directorios de origen o de salida.
@@ -0,0 +1,71 @@
1
+ ---
2
+ title: ZEN - Generador de Sitios Estáticos Minimalista con Markdown + IA
3
+ summary: ZEN es un generador de sitios estáticos con IA, que admite navegación por categorías inteligente y traducción incremental automática, permitiendo a los usuarios centrarse en escribir en su lengua materna y simplificando el proceso de configuración y construcción.
4
+ tags:
5
+ - Generador de Sitios Estáticos
6
+ - Markdown
7
+ - IA
8
+ - Traducción Multilingüe
9
+ - Minimalismo
10
+ - Herramientas de Documentación
11
+ - Node.js
12
+ inferred_lang: es-ES
13
+ ---
14
+
15
+ # ZEN - Generador de Sitios Estáticos Minimalista con Markdown + IA
16
+
17
+ [> Demostración del Sitio Web](https://zccz14.github.io/ZEN/)
18
+
19
+ ## Funcionalidades Básicas
20
+
21
+ 1. 📃 **Generación de Sitios Estáticos**: Construye un sitio HTML estático a partir de cualquier carpeta git que contenga archivos Markdown.
22
+ 2. 🧭 **Navegación por Categorías Inteligente**: Utiliza IA para analizar el contenido, generando un mapa del sitio y navegación, independientemente de la ubicación de los archivos fuente.
23
+ 3. 🌍 **Traducción Incremental Automática**: Utiliza IA para realizar traducciones incrementales, permitiendo a los usuarios escribir Markdown en su lengua materna, pero siendo multilingües.
24
+
25
+ ¿Por qué crear otro generador de sitios estáticos con Markdown? He reflexionado sobre cómo las herramientas de documentación pueden servir mejor a los escritores en la era de la IA:
26
+
27
+ - **Regreso al Contenido**: Minimizar las distracciones, centrarse en escribir.
28
+
29
+ Devolver la documentación a su esencia, devolver la escritura a la tranquilidad.
30
+
31
+ Primero, no quiero ser un bibliotecario. A veces quiero escribir algo, pero quizás aún no he pensado en su título o no lo he organizado de manera específica. Quiero que un LLM me ayude automáticamente generando títulos, resúmenes, categorías, navegación y otras tareas de organización.
32
+
33
+ Segundo, mi estudio debe estar ordenado. No quiero herramientas de construcción con configuraciones complejas, ni lidiar con configuraciones de documentos complicadas, ni estructuras complejas. Cada vez que veo los archivos de configuración y estructuras de proyectos de herramientas como Docusaurus, VuePress o Astro, me duele la cabeza. Ahora, ZEN opta por ocultar toda la configuración en el directorio `.zen`, barriéndola bajo la alfombra. El usuario solo necesita centrarse en escribir el contenido; ZEN se encarga del resto. Todos los demás directorios son su espacio de escritura, puede organizar sus archivos Markdown como desee.
34
+
35
+ - **Regreso a la Lengua Materna**: Escribir en la lengua materna, construir versiones multilingües sin esfuerzo.
36
+
37
+ La vida es corta, no tengo ganas de traducir. Uno expresa mejor su profundidad de pensamiento cuando usa su lengua materna. Pero al mismo tiempo, es necesario mantenerse conectado con el mundo; no quiero renunciar a la comunicación multilingüe. Por eso, deseo una herramienta que me permita escribir en mi lengua materna y, a la vez, hacer que más personas vean mi contenido. Los sistemas i18n actuales no solo requieren que uno traduzca, sino que también mantenga las actualizaciones del contenido, lo cual es muy tedioso. Elijo usar LLM para ayudarme con la traducción, ahorrándome mucho tiempo y permitiéndome completar traducciones a múltiples idiomas con un solo clic.
38
+
39
+ ## Comenzar Rápidamente
40
+
41
+ Requisitos previos:
42
+
43
+ - Tener instalado [Node.js](https://nodejs.org/) (se recomienda versión 18 o superior, debe incluir el comando `npx`)
44
+ - Haber obtenido una [Clave API de OpenAI](https://platform.openai.com/account/api-keys), o una clave API compatible con OpenAI.
45
+ - Tener instalado Git (para listar archivos Markdown desde un repositorio Git, ignorando los archivos filtrados por las reglas de `.gitignore`).
46
+
47
+ Primero, trabaje en una carpeta que ya esté gestionada por Git:
48
+
49
+ Configure las variables de entorno:
50
+
51
+ ```bash
52
+ export OPENAI_API_KEY="sk-xxxxxx" # Obligatorio: Reemplazar con su Clave API de OpenAI
53
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # Opcional, por defecto usa la API oficial de OpenAI
54
+ export OPENAI_MODEL="gpt-3.5-turbo" # Opcional, por defecto usa el modelo gpt-3.5-turbo
55
+ ```
56
+
57
+ Construya el sitio, con soporte para traducción multilingüe. Usa el directorio actual como directorio fuente y la salida va al directorio `.zen/dist`.
58
+
59
+ - Puede especificar las versiones de idioma a generar usando múltiples veces el parámetro `--lang` (por ejemplo, `--lang es-ES --lang en-US`).
60
+ - Puede especificar el prefijo de URL base del sitio con el parámetro `--base-url` (por ejemplo, el nombre del repositorio en GitHub Pages).
61
+ - No es necesario configurar el idioma fuente; ZEN lo detecta automáticamente.
62
+
63
+ ```bash
64
+ npx zengen@latest build --lang es-ES --lang en-US
65
+ ```
66
+
67
+ **Ver más parámetros o ayuda**:
68
+
69
+ ```bash
70
+ npx zengen@latest
71
+ ```
@@ -0,0 +1,71 @@
1
+ ---
2
+ title: ZEN - Generador de Sitios Estáticos Minimalista con Markdown + IA
3
+ summary: ZEN es un generador de sitios estáticos potenciado por IA, que admite navegación por categorías inteligente y traducción incremental automática, permitiendo a los usuarios centrarse en escribir en su idioma nativo y simplificando el proceso de configuración y construcción.
4
+ tags:
5
+ - Generador de Sitios Estáticos
6
+ - Markdown
7
+ - IA
8
+ - Traducción Multilingüe
9
+ - Minimalismo
10
+ - Herramientas de Documentación
11
+ - Node.js
12
+ inferred_lang: es-MX
13
+ ---
14
+
15
+ # ZEN - Generador de Sitios Estáticos Minimalista con Markdown + IA
16
+
17
+ [> Demostración del Sitio Web](https://zccz14.github.io/ZEN/)
18
+
19
+ ## Funcionalidades Básicas
20
+
21
+ 1. 📃 **Generación de Sitios Estáticos**: Construye un sitio HTML estático a partir de cualquier carpeta git que contenga archivos Markdown.
22
+ 2. 🧭 **Navegación por Categorías Inteligente**: Utiliza IA para analizar el contenido, generando un mapa del sitio y navegación, sin depender de la ubicación de los archivos fuente.
23
+ 3. 🌍 **Traducción Incremental Automática**: Utiliza IA para realizar traducciones incrementales, permitiendo a los usuarios escribir Markdown en su idioma nativo, pero pudiendo ser multilingües.
24
+
25
+ ¿Por qué crear otro generador de sitios estáticos con Markdown? He reconsiderado cómo las herramientas de documentación pueden servir mejor a los escritores en la era de la IA:
26
+
27
+ - **Regreso al contenido**: Minimizar las distracciones, enfocarse en escribir.
28
+
29
+ Devolver la documentación a su esencia, devolver la tranquilidad a la escritura.
30
+
31
+ Primero, no quiero ser un bibliotecario. A veces quiero escribir algo, pero quizás aún no he pensado en su título o no lo he organizado de manera específica. Espero que un LLM me ayude automáticamente a generar títulos, hacer resúmenes, clasificar, navegar y otras tareas de organización.
32
+
33
+ Segundo, mi estudio debe estar impecable. No quiero herramientas de construcción con configuraciones complejas, ni configuraciones de documentos complicadas, ni estructuras complejas. Cada vez que veo los archivos de configuración y la estructura de proyectos de herramientas como Docusaurus, VuePress o Astro, me duele la cabeza. Ahora, ZEN opta por ocultar toda la configuración en el directorio `.zen`, barriéndola bajo la alfombra. El usuario solo necesita centrarse en escribir el contenido; ZEN se encarga del resto. Todos los demás directorios son su espacio de escritura, puede organizar sus archivos Markdown como desee.
34
+
35
+ - **Regreso al idioma nativo**: Escribir en la lengua materna, construir versiones multilingües sin esfuerzo.
36
+
37
+ La vida es corta, no tengo ganas de traducir. Las personas alcanzan su máxima profundidad de pensamiento cuando usan su idioma nativo. Pero al mismo tiempo, es necesario mantenerse conectado con el mundo; no quiero renunciar a la comunicación multilingüe. Por lo tanto, deseo una herramienta que me permita escribir en mi idioma nativo y, a la vez, permita que más personas vean mi contenido. Actualmente, la i18n no solo requiere que uno traduzca, sino que también mantenga las actualizaciones del contenido, lo cual es muy tedioso. He optado por usar LLM para ayudarme con la traducción, ahorrándome mucho tiempo y permitiéndome completar traducciones a múltiples idiomas con un solo clic.
38
+
39
+ ## Comenzar Rápidamente
40
+
41
+ Requisitos previos:
42
+
43
+ - Tener [Node.js](https://nodejs.org/) instalado (se recomienda versión 18 o superior, debe incluir el comando `npx`)
44
+ - Haber obtenido una [Clave API de OpenAI](https://platform.openai.com/account/api-keys), o una clave API compatible con OpenAI.
45
+ - Tener Git instalado (para listar archivos Markdown desde un repositorio Git, ignorando los archivos filtrados por las reglas de `.gitignore`).
46
+
47
+ Primero, trabaje en una carpeta que ya esté gestionada por Git:
48
+
49
+ Configure las variables de entorno:
50
+
51
+ ```bash
52
+ export OPENAI_API_KEY="sk-xxxxxx" # Obligatorio: reemplazar con su Clave API de OpenAI
53
+ export OPENAI_BASE_URL="https://api.openai.com/v1" # Opcional, por defecto usa la API oficial de OpenAI
54
+ export OPENAI_MODEL="gpt-3.5-turbo" # Opcional, por defecto usa el modelo gpt-3.5-turbo
55
+ ```
56
+
57
+ Construya el sitio, con soporte para traducción multilingüe. Usa el directorio actual como fuente y genera la salida en el directorio `.zen/dist`.
58
+
59
+ - Puede especificar las versiones de idioma a generar usando múltiples veces el parámetro `--lang` (por ejemplo, `--lang es-MX --lang en-US`).
60
+ - Puede especificar el prefijo de URL base del sitio con el parámetro `--base-url` (por ejemplo, el nombre del repositorio en GitHub Pages).
61
+ - No es necesario configurar el idioma fuente; ZEN lo detectará automáticamente.
62
+
63
+ ```bash
64
+ npx zengen@latest build --lang es-MX --lang en-US
65
+ ```
66
+
67
+ **Ver más parámetros o ayuda**:
68
+
69
+ ```bash
70
+ npx zengen@latest
71
+ ```