zengen 0.2.6 → 0.3.1
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.
- package/.zen/meta.json +24 -7
- package/.zen/src/ar-SA/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/ar-SA/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/ar-SA/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/da-DK/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/da-DK/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/da-DK/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/de-DE/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/de-DE/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/de-DE/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/en-US/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/en-US/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/en-US/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/es-ES/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/es-ES/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/es-ES/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/es-MX/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/es-MX/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/es-MX/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/fi-FI/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/fi-FI/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/fi-FI/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/fr-FR/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/fr-FR/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/fr-FR/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/hi-IN/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/hi-IN/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/hi-IN/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/id-ID/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/id-ID/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/id-ID/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/it-IT/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/it-IT/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/it-IT/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/ja-JP/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/ja-JP/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/ja-JP/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/ko-KR/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/ko-KR/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/ko-KR/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/nl-NL/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/nl-NL/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/nl-NL/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/no-NO/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/no-NO/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/no-NO/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/pl-PL/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/pl-PL/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/pl-PL/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/pt-BR/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/pt-BR/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/pt-BR/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/pt-PT/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/pt-PT/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/pt-PT/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/ru-RU/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/ru-RU/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/ru-RU/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/sv-SE/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/sv-SE/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/sv-SE/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/th-TH/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/th-TH/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/th-TH/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/tr-TR/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/tr-TR/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/tr-TR/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/uk-UA/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/uk-UA/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/uk-UA/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/vi-VN/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/vi-VN/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/vi-VN/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/zh-Hans/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +123 -0
- package/.zen/src/zh-Hans/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +74 -0
- package/.zen/src/zh-Hans/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +75 -0
- package/.zen/src/zh-Hant/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +123 -0
- package/.zen/src/zh-Hant/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/zh-Hant/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/README.md +1 -2
- package/assets/templates/default/layout.html +82 -0
- package/dist/build/pipeline.d.ts.map +1 -1
- package/dist/build/pipeline.js +0 -1
- package/dist/build/pipeline.js.map +1 -1
- package/dist/cli.js +0 -2
- package/dist/cli.js.map +1 -1
- package/dist/process/template.d.ts.map +1 -1
- package/dist/process/template.js +3 -4
- package/dist/process/template.js.map +1 -1
- package/dist/types.d.ts +0 -1
- package/dist/types.d.ts.map +1 -1
- package/dist/utils/convertMarkdownToHtml.d.ts.map +1 -1
- package/dist/utils/convertMarkdownToHtml.js +75 -22
- package/dist/utils/convertMarkdownToHtml.js.map +1 -1
- package/docs/test-mermaid.md +105 -0
- package/package.json +2 -2
- package/src/build/pipeline.ts +0 -1
- package/src/cli.ts +0 -2
- package/src/process/template.ts +3 -9
- package/src/types.ts +0 -1
- package/src/utils/convertMarkdownToHtml.ts +80 -21
|
@@ -0,0 +1,70 @@
|
|
|
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 integrada, enfocado en simplificar la escritura de documentación y el proceso de construcción. Permite a los usuarios crear sitios HTML estáticos usando Markdown en carpetas gestionadas por git, sin configuraciones complejas; toda la configuración se oculta en el directorio .zen. Sus funciones principales incluyen navegación por categorización inteligente (genera mapas del sitio mediante análisis de contenido con IA), traducción automática incremental (soporta versiones multilingüe, los usuarios pueden escribir en su idioma nativo y la IA maneja la traducción), y una experiencia de escritura con mínimas interrupciones. La herramienta depende de Node.js, una clave API de OpenAI y Git, se construye rápidamente mediante línea de comandos y admite parámetros de idioma como zh-Hans y en-US.'
|
|
4
|
+
'tags':
|
|
5
|
+
- 'Generador de sitios estáticos'
|
|
6
|
+
- 'Markdown'
|
|
7
|
+
- 'IA'
|
|
8
|
+
- 'Traducción multilingüe'
|
|
9
|
+
- 'Minimalismo'
|
|
10
|
+
- 'Herramienta de documentación'
|
|
11
|
+
- 'ZEN'
|
|
12
|
+
'inferred_lang': 'zh-Hans'
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Generador de sitios estáticos minimalista con Markdown + IA
|
|
16
|
+
|
|
17
|
+
[> Demostración del sitio web](https://zen.zccz14.com/)
|
|
18
|
+
|
|
19
|
+
## Funcionalidades básicas
|
|
20
|
+
|
|
21
|
+
1. 📃 **Generación de sitios estáticos**: Convierte cualquier carpeta gestionada por git que contenga Markdown en un sitio HTML estático.
|
|
22
|
+
2. 🧭 **Navegación por categorización 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 automática incremental**: Emplea IA para realizar traducciones incrementales, permitiendo a los usuarios escribir Markdown en su idioma nativo, pero con soporte multilingüe.
|
|
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 interrupciones, 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 he organizado bien las ideas. Me gustaría que un LLM me ayudara automáticamente a generar títulos, resúmenes, categorías, navegación y otras tareas de organización.
|
|
32
|
+
|
|
33
|
+
Segundo, mi espacio de trabajo 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, barriéndola bajo la alfombra, para que el usuario solo se concentre 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 libremente.
|
|
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, y no quiero renunciar a la comunicación multilingüe. Por eso, deseaba una herramienta que me permitiera escribir en mi idioma nativo y, a la vez, llegar a más personas con mi contenido. Los sistemas actuales de i18n no solo requieren 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 las traducciones, 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 Git, ignorando los filtrados por reglas de .gitignore)
|
|
46
|
+
|
|
47
|
+
Primero, trabaje en una carpeta ya gestionada por git:
|
|
48
|
+
|
|
49
|
+
Configure las variables de entorno:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
export OPENAI_API_KEY="sk-xxxxxx" # Obligatorio: reemplace 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. Use el directorio actual como fuente y genere la salida en el directorio `.zen/dist`.
|
|
58
|
+
|
|
59
|
+
- Puede especificar las versiones de idioma que desea generar usando múltiples veces el parámetro `--lang` (por ejemplo, `--lang zh-Hans --lang en-US`).
|
|
60
|
+
- No es necesario configurar el idioma fuente; ZEN lo detectará automáticamente.
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
npx zengen@latest build --lang zh-Hans --lang en-US
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
**Ver más parámetros o ayuda**:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
npx zengen@latest
|
|
70
|
+
```
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
'title': 'ZEN - Constructor de Sitios Estáticos Minimalista con Markdown + IA'
|
|
3
|
+
'summary': 'ZEN es un generador de sitios estáticos con funciones de IA, diseñado específicamente para documentos Markdown. Permite a los usuarios convertir una carpeta Git que contenga archivos Markdown en un sitio HTML estático, sin configuraciones complejas; toda la configuración se oculta en el directorio .zen. Las funciones principales incluyen navegación por categorías inteligente (utilizando IA para analizar el contenido y generar un mapa del sitio), traducción automática incremental (soporte para versiones multilingüe, los usuarios pueden escribir en su idioma nativo y la IA maneja la traducción) y una experiencia de escritura con mínimas interrupciones. La guía de inicio rápido requiere instalar Node.js, obtener una clave API de OpenAI y Git, construir el sitio mediante la línea de comandos, y permite especificar el idioma y la URL base.'
|
|
4
|
+
'tags':
|
|
5
|
+
- 'Generador de sitios estáticos'
|
|
6
|
+
- 'Markdown'
|
|
7
|
+
- 'IA'
|
|
8
|
+
- 'Traducción multilingüe'
|
|
9
|
+
- 'Minimalismo'
|
|
10
|
+
- 'Herramienta de documentación'
|
|
11
|
+
- 'Git'
|
|
12
|
+
'inferred_lang': 'zh-Hans'
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Constructor de Sitios Estáticos Minimalista con Markdown + IA
|
|
16
|
+
|
|
17
|
+
[> Demostración del sitio web](https://zen.zccz14.com/)
|
|
18
|
+
|
|
19
|
+
## Funciones básicas
|
|
20
|
+
|
|
21
|
+
1. 📃 **Generación de sitios estáticos**: Convierte cualquier carpeta git que contenga Markdown en un sitio HTML estático.
|
|
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 automática incremental**: Utiliza IA para realizar traducciones incrementales, permitiendo a los usuarios escribir Markdown en su idioma nativo, pero ofreciendo contenido multilingüe.
|
|
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 interrupciones, enfocarse en la escritura
|
|
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 he organizado bien las ideas. Espero que un LLM me ayude automáticamente a generar títulos, resúmenes, categorías, navegación y otras tareas de organización.
|
|
32
|
+
|
|
33
|
+
Segundo, mi espacio de trabajo debe estar ordenado. No quiero herramientas de construcción con configuraciones complejas, ni configuraciones de documentos complicadas, ni estructuras enrevesadas. 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, 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 libremente.
|
|
34
|
+
|
|
35
|
+
- **Regreso al idioma nativo**: Escribir en el idioma materno, 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 materno. Pero al mismo tiempo, es necesario mantenerse conectado con el mundo, y no quiero renunciar a la comunicación multilingüe. Por eso, deseo una herramienta que me permita escribir en mi idioma nativo y, a la vez, hacer que mi contenido llegue a más personas. 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 LLM para ayudarme con las traducciones, ahorrándome mucho tiempo y permitiéndome completar traducciones a múltiples idiomas con un solo clic.
|
|
38
|
+
|
|
39
|
+
## Inicio rápido
|
|
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 Git, ignorando los 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: reemplace 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. Utilice el directorio actual como directorio fuente y genere la salida en el directorio `.zen/dist`.
|
|
58
|
+
|
|
59
|
+
- Puede especificar las versiones de idioma que desea generar usando múltiples veces el parámetro `--lang` (por ejemplo, `--lang zh-Hans --lang en-US`).
|
|
60
|
+
- Puede especificar el prefijo de la 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 zh-Hans --lang en-US
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
**Para ver más parámetros o ayuda**:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx zengen@latest
|
|
71
|
+
```
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
---
|
|
2
|
+
'title': 'Documento de prueba de diagramas Mermaid'
|
|
3
|
+
'summary': 'Este documento es un archivo de prueba para verificar la funcionalidad de renderizado de diagramas Mermaid en ZEN. Incluye ejemplos de varios tipos de diagramas Mermaid, como diagramas de flujo, diagramas de secuencia, diagramas de Gantt, diagramas de clases, diagramas de estado y gráficos circulares, además de una prueba de sintaxis errónea para verificar la visualización de mensajes de error. El documento tiene como objetivo demostrar el funcionamiento correcto de la integración de Mermaid en ZEN.'
|
|
4
|
+
'tags':
|
|
5
|
+
- 'Mermaid'
|
|
6
|
+
- 'Prueba de diagramas'
|
|
7
|
+
- 'ZEN'
|
|
8
|
+
- 'Diagrama de flujo'
|
|
9
|
+
- 'Diagrama de secuencia'
|
|
10
|
+
- 'Diagrama de Gantt'
|
|
11
|
+
- 'Diagrama de clases'
|
|
12
|
+
- 'Diagrama de estado'
|
|
13
|
+
'inferred_date': '2024-01-01'
|
|
14
|
+
'inferred_lang': 'es-MX'
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# Prueba de diagramas Mermaid
|
|
18
|
+
|
|
19
|
+
Este es un archivo de prueba para verificar la funcionalidad de renderizado de diagramas Mermaid en ZEN.
|
|
20
|
+
|
|
21
|
+
## Ejemplo de diagrama de flujo
|
|
22
|
+
|
|
23
|
+
```mermaid
|
|
24
|
+
graph TD
|
|
25
|
+
A[Inicio] --> B{¿Continuar?}
|
|
26
|
+
B -->|Sí| C[Ejecutar acción]
|
|
27
|
+
B -->|No| D[Fin]
|
|
28
|
+
C --> E[Verificar resultado]
|
|
29
|
+
E --> F{¿Éxito?}
|
|
30
|
+
F -->|Sí| G[Completado]
|
|
31
|
+
F -->|No| H[Reintentar]
|
|
32
|
+
H --> C
|
|
33
|
+
G --> D
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Ejemplo de diagrama de secuencia
|
|
37
|
+
|
|
38
|
+
```mermaid
|
|
39
|
+
sequenceDiagram
|
|
40
|
+
participant Usuario
|
|
41
|
+
participant Sistema
|
|
42
|
+
participant BaseDeDatos
|
|
43
|
+
|
|
44
|
+
Usuario->>Sistema: Enviar solicitud
|
|
45
|
+
Sistema->>BaseDeDatos: Consultar datos
|
|
46
|
+
BaseDeDatos-->>Sistema: Devolver resultados
|
|
47
|
+
Sistema-->>Usuario: Mostrar resultados
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Ejemplo de diagrama de Gantt
|
|
51
|
+
|
|
52
|
+
```mermaid
|
|
53
|
+
gantt
|
|
54
|
+
title Cronograma del proyecto
|
|
55
|
+
dateFormat YYYY-MM-DD
|
|
56
|
+
section Diseño
|
|
57
|
+
Análisis de requisitos :done, des1, 2024-01-01, 7d
|
|
58
|
+
Diseño de prototipo :active, des2, 2024-01-08, 5d
|
|
59
|
+
Diseño detallado : des3, after des2, 5d
|
|
60
|
+
section Desarrollo
|
|
61
|
+
Desarrollo frontend : dev1, after des3, 10d
|
|
62
|
+
Desarrollo backend : dev2, after des3, 15d
|
|
63
|
+
section Pruebas
|
|
64
|
+
Pruebas unitarias : test1, after dev1, 5d
|
|
65
|
+
Pruebas de integración : test2, after dev2, 5d
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Ejemplo de diagrama de clases
|
|
69
|
+
|
|
70
|
+
```mermaid
|
|
71
|
+
classDiagram
|
|
72
|
+
class Animal {
|
|
73
|
+
+String nombre
|
|
74
|
+
+int edad
|
|
75
|
+
+void comer()
|
|
76
|
+
+void dormir()
|
|
77
|
+
}
|
|
78
|
+
class Perro {
|
|
79
|
+
+void ladrar()
|
|
80
|
+
}
|
|
81
|
+
class Gato {
|
|
82
|
+
+void maullar()
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
Animal <|-- Perro
|
|
86
|
+
Animal <|-- Gato
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Ejemplo de diagrama de estado
|
|
90
|
+
|
|
91
|
+
```mermaid
|
|
92
|
+
stateDiagram-v2
|
|
93
|
+
[*] --> Inactivo
|
|
94
|
+
Inactivo --> Procesando : Iniciar procesamiento
|
|
95
|
+
Procesando --> Éxito : Procesamiento exitoso
|
|
96
|
+
Procesando --> Error : Procesamiento fallido
|
|
97
|
+
Éxito --> [*]
|
|
98
|
+
Error --> [*]
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
## Ejemplo de gráfico circular
|
|
102
|
+
|
|
103
|
+
```mermaid
|
|
104
|
+
pie title Uso de navegadores
|
|
105
|
+
"Chrome" : 65.2
|
|
106
|
+
"Firefox" : 15.3
|
|
107
|
+
"Safari" : 12.5
|
|
108
|
+
"Edge" : 5.2
|
|
109
|
+
"Otros" : 1.8
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## Prueba de sintaxis errónea (debe mostrar mensaje de error)
|
|
113
|
+
|
|
114
|
+
```mermaid
|
|
115
|
+
graph TD
|
|
116
|
+
A --> B
|
|
117
|
+
// Aquí falta la definición de flecha
|
|
118
|
+
C --> D
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
Este archivo de prueba incluye varios tipos de diagramas Mermaid para verificar que la integración de Mermaid en ZEN funcione correctamente.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
'title': 'ZEN - Constructor de sitios estáticos minimalista con Markdown + IA'
|
|
3
|
+
'summary': 'ZEN es un generador de sitios estáticos con IA, enfocado en simplificar la escritura de documentación y el proceso de construcción. Permite a los usuarios crear sitios HTML estáticos usando Markdown en carpetas gestionadas por git, sin configuraciones complejas; toda la configuración se oculta en el directorio .zen. Sus funciones principales incluyen navegación inteligente por categorías (genera un mapa del sitio mediante análisis de contenido con IA), traducción automática incremental (soporta versiones multilingüe, los usuarios pueden escribir en su idioma nativo y la IA maneja la traducción) y una experiencia de escritura con mínimas interrupciones. La herramienta depende de Node.js, una clave API de OpenAI y Git, se construye rápidamente mediante línea de comandos y soporta parámetros de idioma como zh-Hans y en-US.'
|
|
4
|
+
'tags':
|
|
5
|
+
- 'Generador de sitios estáticos'
|
|
6
|
+
- 'Markdown'
|
|
7
|
+
- 'IA'
|
|
8
|
+
- 'Traducción multilingüe'
|
|
9
|
+
- 'Minimalismo'
|
|
10
|
+
- 'Herramienta de documentación'
|
|
11
|
+
- 'ZEN'
|
|
12
|
+
'inferred_lang': 'zh-Hans'
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Constructor de sitios estáticos minimalista con Markdown + IA
|
|
16
|
+
|
|
17
|
+
[> Demostración del sitio web](https://zen.zccz14.com/)
|
|
18
|
+
|
|
19
|
+
## Funcionalidades básicas
|
|
20
|
+
|
|
21
|
+
1. 📃 **Generación de sitios estáticos**: Convierte cualquier carpeta git que contenga Markdown en un sitio HTML estático.
|
|
22
|
+
2. 🧭 **Navegación inteligente por categorías**: 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 automática incremental**: Emplea IA para traducciones incrementales, permitiendo a los usuarios escribir Markdown en su idioma nativo, pero con soporte multilingüe.
|
|
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
|
+
- **Regresar al contenido**: Minimizar interrupciones, 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 adecuadamente. Deseo que un LLM me ayude automáticamente a generar títulos, resúmenes, categorías, navegación y otras tareas de organización.
|
|
32
|
+
|
|
33
|
+
Segundo, mi espacio de trabajo 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 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, para que el usuario solo se enfoque en escribir el contenido y deje el resto a ZEN. Los demás directorios son su espacio de escritura, donde puede organizar sus archivos Markdown libremente.
|
|
34
|
+
|
|
35
|
+
- **Regresar al idioma nativo**: Escribir en el idioma materno, 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 eso, deseo una herramienta que me permita escribir en mi idioma nativo y, a la vez, llegar a más personas con mi contenido. Actualmente, la internacionalización (i18n) no solo requiere que uno mismo traduzca, sino que también mantenga las actualizaciones del contenido, lo cual es muy tedioso. He optado por usar LLM para ayudarme con las traducciones, 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
|
+
- Obtener 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 Git, ignorando los filtrados por reglas de .gitignore)
|
|
46
|
+
|
|
47
|
+
Primero, trabaje en una carpeta ya gestionada por git:
|
|
48
|
+
|
|
49
|
+
Configure las variables de entorno
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
export OPENAI_API_KEY="sk-xxxxxx" # Obligatorio: reemplace 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. Use el directorio actual como fuente y genere la salida en el directorio `.zen/dist`.
|
|
58
|
+
|
|
59
|
+
- Puede especificar los idiomas a generar usando múltiples veces el parámetro `--lang` (por ejemplo, `--lang zh-Hans --lang en-US`).
|
|
60
|
+
- No es necesario configurar el idioma fuente; ZEN lo detectará automáticamente.
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
npx zengen@latest build --lang zh-Hans --lang en-US
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
**Ver más parámetros o ayuda**:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
npx zengen@latest
|
|
70
|
+
```
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
'title': 'ZEN - Constructor de Sitios Estáticos Minimalista con Markdown + IA'
|
|
3
|
+
'summary': 'ZEN es un generador de sitios estáticos con funciones de IA, diseñado específicamente para documentos Markdown. Permite a los usuarios convertir una carpeta Git que contenga archivos Markdown en un sitio HTML estático, sin configuraciones complejas; toda la configuración se oculta en el directorio .zen. Las funciones principales incluyen navegación por categorización inteligente (usando IA para analizar el contenido y generar un mapa del sitio), traducción automática incremental (soporte para versiones multilingüe, los usuarios pueden escribir en su idioma nativo y la IA maneja la traducción) y una experiencia de escritura con mínimas interrupciones. La guía de inicio rápido requiere instalar Node.js, obtener una clave API de OpenAI y Git, construir el sitio mediante línea de comandos, y permite especificar idioma y URL base.'
|
|
4
|
+
'tags':
|
|
5
|
+
- 'Generador de Sitios Estáticos'
|
|
6
|
+
- 'Markdown'
|
|
7
|
+
- 'IA'
|
|
8
|
+
- 'Traducción Multilingüe'
|
|
9
|
+
- 'Minimalismo'
|
|
10
|
+
- 'Herramienta de Documentación'
|
|
11
|
+
- 'Git'
|
|
12
|
+
'inferred_lang': 'es-MX'
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Constructor de Sitios Estáticos Minimalista con Markdown + IA
|
|
16
|
+
|
|
17
|
+
[> Demostración del Sitio Web](https://zen.zccz14.com/)
|
|
18
|
+
|
|
19
|
+
## Funcionalidades Básicas
|
|
20
|
+
|
|
21
|
+
1. 📃 **Generación de Sitios Estáticos**: Convierte cualquier carpeta git que contenga Markdown en un sitio HTML estático.
|
|
22
|
+
2. 🧭 **Navegación por Categorización 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 Automática Incremental**: Emplea IA para realizar traducciones incrementales, permitiendo a los usuarios escribir Markdown en su idioma nativo, mientras el sitio puede ser multilingüe.
|
|
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 Interrupciones, Enfocarse en Escribir**
|
|
28
|
+
|
|
29
|
+
Devolver la esencia a la documentación, 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. Deseo 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 espacio de trabajo debe estar ordenado. No quiero herramientas de construcción con configuraciones complejas, lidiar con configuraciones de documentos intrincadas o 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`, barriéndola bajo la alfombra. El usuario solo necesita enfocarse 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, me da flojera traducir. Uno alcanza su máxima profundidad de pensamiento cuando usa su idioma nativo. Pero al mismo tiempo, es necesario mantenerse conectado con el mundo; no quiero renunciar a la comunicación multilingüe. Por eso, deseaba una herramienta que me permitiera escribir en mi idioma nativo y, a la vez, permitir que más personas vieran mi contenido. Los sistemas i18n actuales no solo requieren que uno mismo traduzca, sino que también debe mantener las actualizaciones del contenido, lo cual es muy tedioso. Elegí usar LLM para ayudarme con la traducción, ahorrándome mucho tiempo y permitiendo completar traducciones a múltiples idiomas con un solo clic.
|
|
38
|
+
|
|
39
|
+
## Comenzando Rápidamente
|
|
40
|
+
|
|
41
|
+
Requisitos Previos:
|
|
42
|
+
|
|
43
|
+
- Tener instalado [Node.js](https://nodejs.org/) (se recomienda versión 18 o superior, necesario 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 (se utiliza para listar archivos Markdown desde un repositorio Git, ignorando los filtrados por reglas `.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: Reemplácelo 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. Utiliza el directorio actual como fuente y la salida va al directorio `.zen/dist`.
|
|
58
|
+
|
|
59
|
+
- Puede especificar las versiones de idioma que desea generar usando múltiples veces el parámetro `--lang` (ej. `--lang zh-Hans --lang en-US`).
|
|
60
|
+
- Puede especificar el prefijo de la URL base del sitio con el parámetro `--base-url` (ej. 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 zh-Hans --lang en-US
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
**Ver más parámetros o ayuda**:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx zengen@latest
|
|
71
|
+
```
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
---
|
|
2
|
+
'title': 'Mermaid-kaavioiden testidokumentti'
|
|
3
|
+
'summary': 'Tämä dokumentti on testitiedosto, jolla varmistetaan Mermaid-kaavioiden renderöintitoiminto ZEN:ssä. Se sisältää esimerkkejä useista Mermaid-kaaviotyypeistä, kuten vuokaavioista, sekvenssikaavioista, Gantt-kaavioista, luokkakaavioista, tilakaavioista ja ympyräkaavioista, sekä sisältää virheellisen syntaksin testauksen virheilmoitusten tarkistamiseksi. Dokumentin tarkoitus on esitellä Mermaid-integraation normaali toiminta ZEN:ssä.'
|
|
4
|
+
'tags':
|
|
5
|
+
- 'Mermaid'
|
|
6
|
+
- 'kaaviotestaus'
|
|
7
|
+
- 'ZEN'
|
|
8
|
+
- 'vuokaavio'
|
|
9
|
+
- 'sekvenssikaavio'
|
|
10
|
+
- 'Gantt-kaavio'
|
|
11
|
+
- 'luokkakaavio'
|
|
12
|
+
- 'tilakaavio'
|
|
13
|
+
'inferred_date': '2024-01-01'
|
|
14
|
+
'inferred_lang': 'fi-FI'
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# Mermaid-kaavioiden testaus
|
|
18
|
+
|
|
19
|
+
Tämä on testitiedosto, jolla varmistetaan Mermaid-kaavioiden renderöintitoiminto ZEN:ssä.
|
|
20
|
+
|
|
21
|
+
## Esimerkki vuokaaviosta
|
|
22
|
+
|
|
23
|
+
```mermaid
|
|
24
|
+
graph TD
|
|
25
|
+
A[开始] --> B{是否继续?}
|
|
26
|
+
B -->|是| C[执行操作]
|
|
27
|
+
B -->|否| D[结束]
|
|
28
|
+
C --> E[检查结果]
|
|
29
|
+
E --> F{是否成功?}
|
|
30
|
+
F -->|是| G[完成]
|
|
31
|
+
F -->|否| H[重试]
|
|
32
|
+
H --> C
|
|
33
|
+
G --> D
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Esimerkki sekvenssikaaviosta
|
|
37
|
+
|
|
38
|
+
```mermaid
|
|
39
|
+
sequenceDiagram
|
|
40
|
+
participant User
|
|
41
|
+
participant System
|
|
42
|
+
participant Database
|
|
43
|
+
|
|
44
|
+
User->>System: 提交请求
|
|
45
|
+
System->>Database: 查询数据
|
|
46
|
+
Database-->>System: 返回结果
|
|
47
|
+
System-->>User: 显示结果
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Esimerkki Gantt-kaaviosta
|
|
51
|
+
|
|
52
|
+
```mermaid
|
|
53
|
+
gantt
|
|
54
|
+
title 项目时间表
|
|
55
|
+
dateFormat YYYY-MM-DD
|
|
56
|
+
section 设计
|
|
57
|
+
需求分析 :done, des1, 2024-01-01, 7d
|
|
58
|
+
原型设计 :active, des2, 2024-01-08, 5d
|
|
59
|
+
详细设计 : des3, after des2, 5d
|
|
60
|
+
section 开发
|
|
61
|
+
前端开发 : dev1, after des3, 10d
|
|
62
|
+
后端开发 : dev2, after des3, 15d
|
|
63
|
+
section 测试
|
|
64
|
+
单元测试 : test1, after dev1, 5d
|
|
65
|
+
集成测试 : test2, after dev2, 5d
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Esimerkki luokkakaaviosta
|
|
69
|
+
|
|
70
|
+
```mermaid
|
|
71
|
+
classDiagram
|
|
72
|
+
class Animal {
|
|
73
|
+
+String name
|
|
74
|
+
+int age
|
|
75
|
+
+void eat()
|
|
76
|
+
+void sleep()
|
|
77
|
+
}
|
|
78
|
+
class Dog {
|
|
79
|
+
+void bark()
|
|
80
|
+
}
|
|
81
|
+
class Cat {
|
|
82
|
+
+void meow()
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
Animal <|-- Dog
|
|
86
|
+
Animal <|-- Cat
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Esimerkki tilakaaviosta
|
|
90
|
+
|
|
91
|
+
```mermaid
|
|
92
|
+
stateDiagram-v2
|
|
93
|
+
[*] --> Idle
|
|
94
|
+
Idle --> Processing : 开始处理
|
|
95
|
+
Processing --> Success : 处理成功
|
|
96
|
+
Processing --> Error : 处理失败
|
|
97
|
+
Success --> [*]
|
|
98
|
+
Error --> [*]
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
## Esimerkki ympyräkaaviosta
|
|
102
|
+
|
|
103
|
+
```mermaid
|
|
104
|
+
pie title 浏览器使用率
|
|
105
|
+
"Chrome" : 65.2
|
|
106
|
+
"Firefox" : 15.3
|
|
107
|
+
"Safari" : 12.5
|
|
108
|
+
"Edge" : 5.2
|
|
109
|
+
"其他" : 1.8
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## Virheellisen syntaksin testaus (pitäisi näyttää virheilmoituksen)
|
|
113
|
+
|
|
114
|
+
```mermaid
|
|
115
|
+
graph TD
|
|
116
|
+
A --> B
|
|
117
|
+
// 这里缺少箭头定义
|
|
118
|
+
C --> D
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
Tämä testitiedosto sisältää useita Mermaid-kaaviotyyppejä, joilla varmistetaan ZEN:n Mermaid-integraation oikea toiminta.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
'title': 'ZEN - Minimalistinen Markdown + AI -staattisen sivuston rakentaja'
|
|
3
|
+
'summary': 'ZEN on AI:ta hyödyntävä staattisen sivuston generaattori, joka keskittyy dokumenttien kirjoittamisen ja rakentamisen yksinkertaistamiseen. Sen avulla käyttäjät voivat luoda staattisia HTML-sivustoja git-hallinnassa oleviin kansioihin käyttäen Markdownia ilman monimutkaisia konfiguraatioita; kaikki asetukset piilotetaan .zen-hakemistoon. Keskeisiin ominaisuuksiin kuuluvat älykäs luokittelu ja navigointi (sivustokartan generointi AI:n analysoimana sisältöä), automaattinen inkrementaalinen käännös (tuki monikielisille versioille, käyttäjä voi kirjoittaa äidinkielellään ja AI käsittelee käännökset) sekä häiriöttömän kirjoittamisen kokemus. Työkalu vaatii Node.js:n, OpenAI API -avaimen ja Git:n, ja se rakentaa sivuston nopeasti komentorivin kautta tukien kieliparametreja kuten zh-Hans ja en-US.'
|
|
4
|
+
'tags':
|
|
5
|
+
- 'staattisen sivuston generaattori'
|
|
6
|
+
- 'Markdown'
|
|
7
|
+
- 'AI'
|
|
8
|
+
- 'monikielinen käännös'
|
|
9
|
+
- 'minimalismi'
|
|
10
|
+
- 'dokumentointityökalu'
|
|
11
|
+
- 'ZEN'
|
|
12
|
+
'inferred_lang': 'zh-Hans'
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Minimalistinen Markdown + AI -staattisen sivuston rakentaja
|
|
16
|
+
|
|
17
|
+
[> Verkkosivuston demo](https://zen.zccz14.com/)
|
|
18
|
+
|
|
19
|
+
## Perustoiminnot
|
|
20
|
+
|
|
21
|
+
1. 📃 **Staattisen sivuston generointi**: Muunna mikä tahansa git-hallinnassa oleva kansio, joka sisältää Markdown-tiedostoja, staattiseksi HTML-sivustoksi.
|
|
22
|
+
2. 🧭 **Älykäs luokittelu ja navigointi**: Käytä AI:ta sisällön analysointiin, generoi sivustokartta ja navigointi. Lähdetiedostojen sijainnilla ei ole merkitystä.
|
|
23
|
+
3. 🌍 **Automaattinen inkrementaalinen käännös**: Käytä AI:ta inkrementaaliseen käännökseen, jotta käyttäjä voi kirjoittaa Markdownia äidinkielellään, mutta lopputulos voi olla monikielinen.
|
|
24
|
+
|
|
25
|
+
Miksi olen luonut taas uuden Markdown-pohjaisen staattisen sivuston generaattorin? Olen uudelleen miettinyt, kuinka dokumentointityökalut voisivat AI-aikakaudella palvella kirjoittajia paremmin:
|
|
26
|
+
|
|
27
|
+
- Palaa sisältöön: minimoi häiriöt, keskity kirjoittamiseen
|
|
28
|
+
|
|
29
|
+
Palauta dokumenttien olemus, palauta kirjoittamisen rauha.
|
|
30
|
+
|
|
31
|
+
Ensinnäkin, en halua olla kirjastonhoitaja. Haluan joskus kirjoittaa jotain sisältöä, mutta en välttämättä ole vielä päättänyt sen otsikosta tai muodostanut selkeää rakennetta. Toivon, että LLM automaattisesti generoisi otsikoita, tekisi yhteenvetoja, luokittelisi ja navigoisi sisältöä.
|
|
32
|
+
|
|
33
|
+
Toiseksi, kirjastoni on puhdistettava siistiksi. En halua monimutkaisia konfiguraatiotyökaluja, enkä halua säätää monimutkaisten dokumenttien asetusten kanssa. Monimutkaiset rakenteet eivät ole mieleeni. Aina kun näen Docusaurusin, VuePressin tai Astron konfiguraatiotiedostot ja projektirakenteet, särkee pääni. Nyt ZEN piilottaa kaikki asetukset .zen-hakemistoon, työntää ne nurkkaan, jotta käyttäjä voi keskittyä vain kirjoittamiseen. Kaikki muut hakemistot ovat kirjoitustilaa, ja voit järjestää Markdown-tiedostosi haluamallasi tavalla.
|
|
34
|
+
|
|
35
|
+
- Palaa äidinkieleen: kirjoita äidinkielellä, luo monikieliset versiot sulavasti
|
|
36
|
+
|
|
37
|
+
Elämä on lyhyt, en jaksa kääntää. Ihmiset pystyvät parhaiten hyödyntämään ajattelunsa syvyyttä äidinkielellään. Mutta yhteydenpito maailmaan on välttämätöntä, enkä halua luopua monikielisestä vuorovaikutuksesta. Siksi toivon työkalua, jonka avulla voin kirjoittaa äidinkielelläni ja samalla tehdä sisältöni saatavilla useammille. Nykyinen i18n vaatii käännösten tekemisen itse ja sisällön päivittämisen, mikä on liian vaivalloista. Käytän LLM:ää auttamaan käännöksissä, mikä säästää aikaani ja mahdollistaa monikielisten käännösten tekemisen yhdellä napsautuksella.
|
|
38
|
+
|
|
39
|
+
## Pika-aloitus
|
|
40
|
+
|
|
41
|
+
Edellytykset:
|
|
42
|
+
|
|
43
|
+
- [Node.js](https://nodejs.org/) asennettuna (suositeltu versio 18 tai uudempi, tarvitaan npx-komento)
|
|
44
|
+
- [OpenAI API -avain](https://platform.openai.com/account/api-keys) hankittu, tai OPENAI-yhteensopiva API-avain
|
|
45
|
+
- Git asennettuna (käytetään Markdown-tiedostojen listaukseen git:stä, .gitignore-sääntöjen mukaisesti suodatettujen tiedostojen ohittamiseksi)
|
|
46
|
+
|
|
47
|
+
Työskentele ensin git-hallinnassa olevassa kansiossa:
|
|
48
|
+
|
|
49
|
+
Määritä ympäristömuuttujat
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
export OPENAI_API_KEY="sk-xxxxxx" # Pakollinen: korvaa omalla OpenAI API -avaimellasi
|
|
53
|
+
export OPENAI_BASE_URL="https://api.openai.com/v1" # Valinnainen, käyttää oletuksena OpenAI:n virallista API:a
|
|
54
|
+
export OPENAI_MODEL="gpt-3.5-turbo" # Valinnainen, käyttää oletuksena gpt-3.5-turbo-mallia
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Rakenna sivusto, tuki monikielisille käännöksille. Käytä nykyistä hakemistoa lähdehakemistona ja tulosta `.zen/dist`-hakemistoon.
|
|
58
|
+
|
|
59
|
+
- Voit määrittää tarvittavat kieliversiot käyttämällä `--lang`-parametria useita kertoja (esim. `--lang zh-Hans --lang en-US`).
|
|
60
|
+
- Lähdekieltä ei tarvitse määrittää, ZEN tunnistaa sen automaattisesti.
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
npx zengen@latest build --lang zh-Hans --lang en-US
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
**Näytä lisää parametreja tai ohjeita**:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
npx zengen@latest
|
|
70
|
+
```
|