zengen 0.2.4 → 0.2.5
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 +27 -18
- package/.zen/src/ar-SA/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +36 -36
- package/.zen/src/ar-SA/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/da-DK/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +29 -29
- package/.zen/src/da-DK/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/de-DE/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +24 -24
- package/.zen/src/de-DE/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/en-US/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +27 -27
- package/.zen/src/en-US/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/es-ES/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +34 -34
- package/.zen/src/es-ES/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/es-MX/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +31 -31
- package/.zen/src/es-MX/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/fi-FI/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +30 -30
- package/.zen/src/fi-FI/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/fr-FR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +26 -26
- package/.zen/src/fr-FR/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/hi-IN/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +29 -29
- package/.zen/src/hi-IN/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/id-ID/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +27 -27
- package/.zen/src/id-ID/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/it-IT/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +38 -38
- package/.zen/src/it-IT/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/ja-JP/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +27 -27
- package/.zen/src/ja-JP/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/ko-KR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +25 -25
- package/.zen/src/ko-KR/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/nl-NL/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +31 -31
- package/.zen/src/nl-NL/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/no-NO/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +32 -32
- package/.zen/src/no-NO/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/pl-PL/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +27 -27
- package/.zen/src/pl-PL/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/pt-BR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +34 -34
- package/.zen/src/pt-BR/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/pt-PT/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +28 -28
- package/.zen/src/pt-PT/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/ru-RU/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +37 -37
- package/.zen/src/ru-RU/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/sv-SE/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +29 -29
- package/.zen/src/sv-SE/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/th-TH/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +30 -30
- package/.zen/src/th-TH/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/tr-TR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +31 -31
- package/.zen/src/tr-TR/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/uk-UA/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +30 -30
- package/.zen/src/uk-UA/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/vi-VN/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +24 -24
- package/.zen/src/vi-VN/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/zh-Hans/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +14 -11
- package/.zen/src/zh-Hans/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +31 -0
- package/.zen/src/zh-Hant/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +18 -15
- package/.zen/src/zh-Hant/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +31 -0
- package/dist/ai/extractMetadataFromMarkdown.js +3 -3
- package/dist/ai/extractMetadataFromMarkdown.js.map +1 -1
- package/dist/process/template.d.ts.map +1 -1
- package/dist/process/template.js +8 -5
- package/dist/process/template.js.map +1 -1
- package/dist/utils/frontmatter.js +1 -1
- package/dist/utils/frontmatter.js.map +1 -1
- package/docs/tricks.md +15 -0
- package/package.json +1 -1
- package/src/ai/extractMetadataFromMarkdown.ts +3 -3
- package/src/process/template.ts +10 -9
- package/src/utils/frontmatter.ts +1 -1
- package/.zen/src/de-DE/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
- package/.zen/src/de-DE/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/en-US/01d04f7c17b4a541ead9d759d877b30b403e15b849182a49eb1f62bd29ecd18c.md +0 -120
- package/.zen/src/en-US/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
- package/.zen/src/en-US/1b798c44a4f353e47296ca83d5905e37e6aba3e90bbd9bc3b3d34fc12059a2ca.md +0 -75
- package/.zen/src/en-US/1e96be58d76c60056b708eb5bd8b8b81d7b5845d9cfe0b879d85068a5f11df3a.md +0 -189
- package/.zen/src/en-US/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/en-US/5ec990146b35e00de2630559126ee07f7cdcddeb23b0e8cab3d85b4181353e26.md +0 -53
- package/.zen/src/en-US/6124ea88edec5bde737b26b21f71ecfeffe4e73151784856edf813ee231a4baa.md +0 -11
- package/.zen/src/en-US/80ae9bed74fc6348a7c1fe9f33e86b65f5d919169721f77bcf0e1bc29fbdb4f9.md +0 -61
- package/.zen/src/en-US/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md +0 -63
- package/.zen/src/en-US/f0c2799126931ccd113a0c45b1e623870b0d4f4f400becf6dd877da8f1011517.md +0 -40
- package/.zen/src/en-US/fdfca9b960d0eaa8b2b96fe988ead7481d2c0b16f66ebc94fb477139b4178cdc.md +0 -65
- package/.zen/src/es-ES/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
- package/.zen/src/es-ES/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/fr-FR/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
- package/.zen/src/fr-FR/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/ja-JP/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -71
- package/.zen/src/ja-JP/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/ko-KR/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/pt-PT/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
- package/.zen/src/pt-PT/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/ru-RU/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
- package/.zen/src/ru-RU/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/zh-Hans/01d04f7c17b4a541ead9d759d877b30b403e15b849182a49eb1f62bd29ecd18c.md +0 -120
- package/.zen/src/zh-Hans/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
- package/.zen/src/zh-Hans/084ef1f6a0167df8621c673c79211309d4af6c588e7bbe3e043f7c244edd0ac6.md +0 -80
- package/.zen/src/zh-Hans/1b798c44a4f353e47296ca83d5905e37e6aba3e90bbd9bc3b3d34fc12059a2ca.md +0 -77
- package/.zen/src/zh-Hans/1e96be58d76c60056b708eb5bd8b8b81d7b5845d9cfe0b879d85068a5f11df3a.md +0 -189
- package/.zen/src/zh-Hans/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/zh-Hans/5ec990146b35e00de2630559126ee07f7cdcddeb23b0e8cab3d85b4181353e26.md +0 -55
- package/.zen/src/zh-Hans/6124ea88edec5bde737b26b21f71ecfeffe4e73151784856edf813ee231a4baa.md +0 -11
- package/.zen/src/zh-Hans/80ae9bed74fc6348a7c1fe9f33e86b65f5d919169721f77bcf0e1bc29fbdb4f9.md +0 -63
- package/.zen/src/zh-Hans/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md +0 -63
- package/.zen/src/zh-Hans/f0c2799126931ccd113a0c45b1e623870b0d4f4f400becf6dd877da8f1011517.md +0 -40
- package/.zen/src/zh-Hans/fdfca9b960d0eaa8b2b96fe988ead7481d2c0b16f66ebc94fb477139b4178cdc.md +0 -65
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: ZEN Documentation Site Example
|
|
3
|
-
summary: Introducing ZEN documentation builder, a minimalist Markdown documentation site generator, including features, quick start guide, code examples, and next-step learning resources.
|
|
4
|
-
tags:
|
|
5
|
-
- ZEN
|
|
6
|
-
- Documentation Builder
|
|
7
|
-
- Markdown
|
|
8
|
-
- Site Generator
|
|
9
|
-
- Quick Start
|
|
10
|
-
- Code Examples
|
|
11
|
-
- Multi-language Support
|
|
12
|
-
inferred_lang: en-US
|
|
13
|
-
---
|
|
14
|
-
|
|
15
|
-
# ZEN Documentation Site Example
|
|
16
|
-
|
|
17
|
-
Welcome to the ZEN documentation builder! This is a minimalist Markdown documentation site generator.
|
|
18
|
-
|
|
19
|
-
## Features
|
|
20
|
-
|
|
21
|
-
- **Minimal Configuration**: No complex configuration files required
|
|
22
|
-
- **Content-First**: Focus on writing, not tool configuration
|
|
23
|
-
- **Smart Navigation**: Automatically generates site maps and navigation
|
|
24
|
-
- **Multi-language Support**: Supports incremental i18n translation
|
|
25
|
-
|
|
26
|
-
## Quick Start
|
|
27
|
-
|
|
28
|
-
```bash
|
|
29
|
-
# Build documentation using npx (recommended)
|
|
30
|
-
npx zengen build
|
|
31
|
-
|
|
32
|
-
# Live preview (watches for file changes)
|
|
33
|
-
npx zengen build --watch
|
|
34
|
-
|
|
35
|
-
# View more parameters or help
|
|
36
|
-
npx zengen
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
**Note**: ZEN enforces the use of the current directory as the source directory and outputs to the `.zen/dist` directory. Specifying source and output directory parameters is no longer supported.
|
|
40
|
-
|
|
41
|
-
## Code Examples
|
|
42
|
-
|
|
43
|
-
```javascript
|
|
44
|
-
// This is a JavaScript example
|
|
45
|
-
const zen = require('zengen');
|
|
46
|
-
|
|
47
|
-
async function buildDocs() {
|
|
48
|
-
await zen.build({
|
|
49
|
-
// ZEN now enforces using the current directory as the source directory
|
|
50
|
-
// Outputs to the .zen/dist directory
|
|
51
|
-
});
|
|
52
|
-
}
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
```python
|
|
56
|
-
# This is a Python example
|
|
57
|
-
def hello_world():
|
|
58
|
-
print("Hello from ZEN!")
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
## Next Steps
|
|
62
|
-
|
|
63
|
-
1. Read the [API Documentation](./api.md)
|
|
64
|
-
2. Check the [Configuration Guide](./config.md)
|
|
65
|
-
3. Learn about [Best Practices](./best-practices.md)
|
|
@@ -1,73 +0,0 @@
|
|
|
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.
|
|
@@ -1,81 +0,0 @@
|
|
|
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.
|
|
@@ -1,73 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: ZEN - Outil de construction de sites de documentation Markdown
|
|
3
|
-
summary: ZEN est un générateur de site statique Markdown minimaliste, axé sur l'écriture de contenu. Il utilise l'IA pour gérer la traduction et la navigation, prend en charge la construction multilingue et ne nécessite aucune configuration complexe.
|
|
4
|
-
tags:
|
|
5
|
-
- Markdown
|
|
6
|
-
- Générateur de site statique
|
|
7
|
-
- Traduction IA
|
|
8
|
-
- Multilingue
|
|
9
|
-
- Minimalisme
|
|
10
|
-
- Outil de documentation
|
|
11
|
-
- ZEN
|
|
12
|
-
inferred_lang: fr-FR
|
|
13
|
-
---
|
|
14
|
-
|
|
15
|
-
# ZEN - Outil de construction de site de documentation Markdown épuré
|
|
16
|
-
|
|
17
|
-
[简体中文](https://zccz14.github.io/ZEN/zh-Hans) | [English](https://zccz14.github.io/ZEN/en-US)
|
|
18
|
-
|
|
19
|
-
Pourquoi créer un autre générateur de site statique Markdown ? J'ai repensé la manière dont les outils de documentation pourraient mieux servir les rédacteurs à l'ère de l'IA :
|
|
20
|
-
|
|
21
|
-
- **Retour au contenu** : Perturbation minimale, concentration sur l'écriture
|
|
22
|
-
|
|
23
|
-
Rendre à la documentation son essence, rendre à l'écriture sa sérénité.
|
|
24
|
-
|
|
25
|
-
Premièrement, je ne veux pas être bibliothécaire. Parfois, je veux écrire du contenu, mais je n'ai peut-être pas encore trouvé son titre ou je n'ai pas encore de structure bien définie. J'aimerais que l'IA génère automatiquement les titres, fasse des résumés, classe et organise la navigation.
|
|
26
|
-
|
|
27
|
-
Deuxièmement, mon espace de travail doit être propre. Je ne veux pas d'outils de construction complexes à configurer, je ne veux pas me battre avec des configurations de documentation compliquées, et je n'aime pas les structures complexes. Chaque fois que je vois les fichiers de configuration et la structure de projet d'outils comme Docusaurus, VuePress ou Astro, j'ai mal à la tête. Maintenant, ZEN choisit de cacher toute la configuration dans le répertoire `.zen`, de la reléguer dans un coin. L'utilisateur se concentre uniquement sur l'écriture du contenu, et ZEN s'occupe du reste. Tous les autres répertoires sont votre espace d'écriture, vous pouvez organiser vos fichiers Markdown comme bon vous semble.
|
|
28
|
-
|
|
29
|
-
- **Retour à la langue maternelle** : Écrire dans sa langue maternelle, construire des versions multilingues de manière fluide
|
|
30
|
-
|
|
31
|
-
La vie est courte, je n'ai pas envie de traduire. On exprime le mieux la profondeur de sa pensée dans sa langue maternelle. Mais en même temps, rester connecté au monde est nécessaire, et je ne veux pas renoncer à la communication multilingue. J'ai donc souhaité un outil qui me permette d'écrire dans ma langue maternelle tout en permettant à plus de personnes de voir mon contenu. Actuellement, l'i18n nécessite non seulement de traduire soi-même, mais aussi de maintenir les mises à jour du contenu, ce qui est trop fastidieux. J'ai choisi d'utiliser l'IA pour m'aider à traduire, ce qui me fait gagner beaucoup de temps et permet de réaliser des traductions multilingues en un clic.
|
|
32
|
-
|
|
33
|
-
## Fonctionnalités de base
|
|
34
|
-
|
|
35
|
-
1. **Génération de site statique**
|
|
36
|
-
- Transforme n'importe quel dossier contenant des fichiers Markdown en un site HTML statique.
|
|
37
|
-
|
|
38
|
-
2. **Navigation intelligente**
|
|
39
|
-
- Génère un plan du site et une navigation. Il n'est pas nécessaire de conserver la structure de répertoire originale des fichiers sources Markdown, vous pouvez déplacer les fichiers sources librement.
|
|
40
|
-
|
|
41
|
-
3. **Traduction i18n incrémentale**
|
|
42
|
-
- Utilise l'IA pour une traduction i18n incrémentale, permettant à l'utilisateur d'écrire en Markdown dans sa langue maternelle, tout en offrant un contenu multilingue.
|
|
43
|
-
|
|
44
|
-
## Philosophie de conception
|
|
45
|
-
|
|
46
|
-
- **Minimalisme** : Configuration minimale, flexibilité maximale.
|
|
47
|
-
- **Priorité au contenu** : Se concentrer sur l'écriture, pas sur la configuration des outils.
|
|
48
|
-
- **IA au service de l'utilisateur** : Utiliser l'IA pour gérer la traduction et l'organisation du contenu.
|
|
49
|
-
- **Multilingue** : Prend en charge la création et l'affichage de contenu multilingue.
|
|
50
|
-
|
|
51
|
-
## Démarrage rapide
|
|
52
|
-
|
|
53
|
-
### Méthode d'utilisation recommandée
|
|
54
|
-
|
|
55
|
-
**Il est recommandé de se placer dans le répertoire contenant les fichiers Markdown et d'utiliser directement la commande suivante pour commencer la construction :**
|
|
56
|
-
|
|
57
|
-
```bash
|
|
58
|
-
# Définir les variables d'environnement (modifiez selon votre situation)
|
|
59
|
-
export OPENAI_API_KEY="sk-xxxxxx" # Obligatoire : remplacez par votre clé API OpenAI
|
|
60
|
-
export OPENAI_BASE_URL="https://api.openai.com/v1" # Optionnel, utilise par défaut l'API officielle OpenAI
|
|
61
|
-
export OPENAI_MODEL="gpt-3.5-turbo" # Optionnel, utilise par défaut le modèle gpt-3.5-turbo
|
|
62
|
-
|
|
63
|
-
# Construire le site, avec prise en charge de la traduction multilingue
|
|
64
|
-
npx zengen@latest build --lang zh-Hans --lang en-US --verbose
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
**Voir plus de paramètres ou obtenir de l'aide** :
|
|
68
|
-
|
|
69
|
-
```bash
|
|
70
|
-
npx zengen
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
**Remarque** : ZEN impose l'utilisation du répertoire courant comme répertoire source et génère la sortie dans le répertoire `.zen/dist`. Il ne prend pas en charge la spécification de paramètres pour le répertoire source ou le répertoire de sortie.
|
|
@@ -1,81 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: ZEN - Outil de construction de site de documentation Markdown
|
|
3
|
-
summary: ZEN est un générateur de site statique Markdown simple, mettant l'accent sur la priorité au contenu et le minimalisme. Il utilise l'IA pour une navigation intelligente et la traduction multilingue, aidant les utilisateurs à se concentrer sur l'écriture sans configuration complexe.
|
|
4
|
-
tags:
|
|
5
|
-
- Markdown
|
|
6
|
-
- Génération de site statique
|
|
7
|
-
- Traduction IA
|
|
8
|
-
- Multilingue
|
|
9
|
-
- Minimalisme
|
|
10
|
-
- Outil de documentation
|
|
11
|
-
- ZEN
|
|
12
|
-
inferred_lang: fr-FR
|
|
13
|
-
---
|
|
14
|
-
|
|
15
|
-
# ZEN - Outil de construction de site de documentation Markdown simple
|
|
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
|
-
Pourquoi créer un autre générateur de site statique Markdown ? J'ai repensé comment les outils de documentation pourraient mieux servir les rédacteurs à l'ère de l'IA :
|
|
28
|
-
|
|
29
|
-
- Retour au contenu : Minimiser les distractions, se concentrer sur l'écriture
|
|
30
|
-
|
|
31
|
-
Ramener la documentation à son essence, ramener l'écriture à la tranquillité.
|
|
32
|
-
|
|
33
|
-
Premièrement, je ne veux pas être bibliothécaire. Parfois, je veux écrire du contenu, mais je n'ai peut-être pas encore trouvé son titre, ni formé une organisation particulière. J'aimerais que l'IA génère automatiquement des titres, fasse des résumés, des catégorisations, de la navigation et d'autres travaux d'organisation pour moi.
|
|
34
|
-
|
|
35
|
-
Deuxièmement, mon bureau doit être rangé. Je ne veux pas d'outils de construction complexes à configurer, je ne veux pas me battre avec des configurations de documentation compliquées, je n'aime pas les structures complexes. Chaque fois que je vois les fichiers de configuration et les structures de projet d'outils comme Docusaurus, VuePress, Astro, j'ai mal à la tête. Maintenant, ZEN choisit de cacher toute la configuration dans le répertoire `.zen`, de la balayer dans un coin. L'utilisateur n'a qu'à se concentrer sur le contenu de l'écriture, le reste est géré par ZEN. Tous les autres répertoires sont votre espace d'écriture, vous pouvez organiser vos fichiers Markdown comme bon vous semble.
|
|
36
|
-
|
|
37
|
-
- Retour à la langue maternelle : Écrire dans sa langue maternelle, construire des versions multilingues de manière fluide
|
|
38
|
-
|
|
39
|
-
La vie est courte, je suis trop paresseux pour traduire. C'est dans sa langue maternelle qu'une personne peut exploiter au mieux la profondeur de sa réflexion. Mais en même temps, rester connecté au monde est nécessaire, je ne veux pas renoncer à la communication multilingue. J'espérais donc un outil qui me permette d'écrire dans ma langue maternelle tout en permettant à plus de gens de voir mon contenu. Actuellement, l'i18n nécessite non seulement de traduire soi-même, mais aussi de maintenir les mises à jour du contenu, c'est trop fastidieux. J'ai choisi d'utiliser l'IA pour m'aider à traduire, ce qui m'économise beaucoup de temps et permet de réaliser des traductions multilingues en un clic.
|
|
40
|
-
|
|
41
|
-
## Fonctionnalités de base
|
|
42
|
-
|
|
43
|
-
1. **Génération de site statique**
|
|
44
|
-
- Transforme n'importe quel dossier contenant des fichiers Markdown en un site HTML statique.
|
|
45
|
-
|
|
46
|
-
2. **Navigation intelligente**
|
|
47
|
-
- Génère un plan du site et une navigation. Il n'est pas nécessaire de conserver la structure de répertoire originale des fichiers sources Markdown, vous pouvez déplacer les fichiers sources à votre guise.
|
|
48
|
-
|
|
49
|
-
3. **Traduction i18n incrémentale**
|
|
50
|
-
- Utilise l'IA pour une traduction i18n incrémentale, permettant aux utilisateurs d'écrire en Markdown dans leur langue maternelle, tout en étant multilingues.
|
|
51
|
-
|
|
52
|
-
## Philosophie de conception
|
|
53
|
-
|
|
54
|
-
- **Minimalisme** : Configuration minimale, flexibilité maximale.
|
|
55
|
-
- **Priorité au contenu** : Se concentrer sur l'écriture, pas sur la configuration des outils.
|
|
56
|
-
- **IA au service** : Utiliser l'IA pour gérer la traduction et l'organisation du contenu.
|
|
57
|
-
- **Multilingue** : Prend en charge la création et l'affichage de contenu multilingue.
|
|
58
|
-
|
|
59
|
-
## Démarrage rapide
|
|
60
|
-
|
|
61
|
-
### Méthode d'utilisation recommandée
|
|
62
|
-
|
|
63
|
-
**Il est recommandé aux utilisateurs de se placer dans le répertoire contenant les fichiers Markdown et d'utiliser directement la commande suivante pour commencer la construction :**
|
|
64
|
-
|
|
65
|
-
```bash
|
|
66
|
-
# Définir les variables d'environnement (modifier selon votre situation réelle)
|
|
67
|
-
export OPENAI_API_KEY="sk-xxxxxx" # Obligatoire : remplacez par votre clé API OpenAI
|
|
68
|
-
export OPENAI_BASE_URL="https://api.openai.com/v1" # Optionnel, utilise par défaut l'API officielle OpenAI
|
|
69
|
-
export OPENAI_MODEL="gpt-3.5-turbo" # Optionnel, utilise par défaut le modèle gpt-3.5-turbo
|
|
70
|
-
|
|
71
|
-
# Construire le site, avec prise en charge de la traduction multilingue
|
|
72
|
-
npx zengen@latest build --lang zh-Hans --lang en-US --verbose
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
**Voir plus de paramètres ou obtenir de l'aide** :
|
|
76
|
-
|
|
77
|
-
```bash
|
|
78
|
-
npx zengen
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
**Remarque** : ZEN impose d'utiliser le répertoire courant comme répertoire source et de sortir dans le répertoire `.zen/dist`. Il ne prend pas en charge les paramètres spécifiant le répertoire source et le répertoire de sortie.
|
|
@@ -1,71 +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: ja-JP
|
|
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
|
-
第一に、私は図書館司書になりたくありません。時々何かを書き留めたいことがありますが、タイトルが決まっていなかったり、明確な構成ができていなかったりします。LLM が自動的にタイトルを生成し、要約、分類、ナビゲーションなどの整理作業をしてくれることを望んでいます。
|
|
25
|
-
|
|
26
|
-
第二に、私の書斎はきれいに掃除されていなければなりません。複雑な設定ファイルを持つビルドツールや、複雑なドキュメント設定、複雑な構造は好みません。Docusaurus、VuePress、Astro などのツールの設定ファイルやプロジェクト構造を見るたびに頭が痛くなります。現在、ZEN はすべての設定を `.zen` ディレクトリに隠し、隅に追いやることを選択しました。ユーザーは執筆内容に集中し、残りは ZEN が処理します。他のディレクトリはすべてあなたの執筆スペースであり、Markdown ファイルを自由に整理できます。
|
|
27
|
-
|
|
28
|
-
- **母国語への回帰:母国語で執筆し、滑らかに多言語バージョンを構築**
|
|
29
|
-
人生は短いので、翻訳は面倒です。人は母国語を使用するとき、自身の思考の深さを最も発揮できます。しかし同時に、世界とのつながりを保つことも必要であり、多言語でのコミュニケーションを諦めたくはありません。そこで、母国語で執筆しながら、より多くの人に私のコンテンツを見てもらえるツールを望んでいます。現在の i18n は自分で翻訳するだけでなく、コンテンツの更新も自分で管理しなければならず、非常に面倒です。私は LLM を使って翻訳を手伝ってもらうことを選択し、多くの時間を節約し、ワンクリックで多国語翻訳を完了できます。
|
|
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
|
-
# 環境変数を設定する (実際の状況に応じて変更してください)
|
|
57
|
-
export OPENAI_API_KEY="sk-xxxxxx" # 必須:ご自身の OpenAI API Key に置き換えてください
|
|
58
|
-
export OPENAI_BASE_URL="https://api.openai.com/v1" # オプション、デフォルトは OpenAI 公式 API を使用
|
|
59
|
-
export OPENAI_MODEL="gpt-3.5-turbo" # オプション、デフォルトは gpt-3.5-turbo モデルを使用
|
|
60
|
-
|
|
61
|
-
# サイトを構築し、多言語翻訳をサポート
|
|
62
|
-
npx zengen@latest build --lang zh-Hans --lang en-US --verbose
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
**その他のパラメータやヘルプを表示する**:
|
|
66
|
-
|
|
67
|
-
```bash
|
|
68
|
-
npx zengen
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
**注意**:ZEN は現在のディレクトリをソースディレクトリとして使用し、`.zen/dist` ディレクトリに出力することを強制します。ソースディレクトリと出力ディレクトリのパラメータ指定はサポートしていません。
|
|
@@ -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: ja-JP
|
|
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,81 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: ZEN - 마크다운 문서 사이트 빌드 도구
|
|
3
|
-
summary: ZEN은 내용 중심과 극도의 간결함을 강조하는 깔끔한 마크다운 정적 사이트 생성 도구입니다. AI를 활용한 지능형 탐색 및 다국어 번역을 통해 사용자가 복잡한 설정 없이 글쓰기에 집중할 수 있도록 돕습니다.
|
|
4
|
-
tags:
|
|
5
|
-
- Markdown
|
|
6
|
-
- 정적 사이트 생성
|
|
7
|
-
- AI 번역
|
|
8
|
-
- 다국어
|
|
9
|
-
- 미니멀리즘
|
|
10
|
-
- 문서 도구
|
|
11
|
-
- ZEN
|
|
12
|
-
inferred_lang: ko-KR
|
|
13
|
-
---
|
|
14
|
-
|
|
15
|
-
# ZEN - 깔끔한 마크다운 문서 사이트 빌드 도구
|
|
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
|
-
왜 또 다른 마크다운 정적 사이트 생성기를 만들었을까요? AI 시대에 문서 도구가 글쓰는 사람에게 어떻게 더 잘 서비스할 수 있을지 다시 생각해보았습니다:
|
|
28
|
-
|
|
29
|
-
- **내용으로의 회귀**: 최소한의 방해, 글쓰기에 집중
|
|
30
|
-
|
|
31
|
-
문서의 본질과 글쓰기의 평온함으로 돌아갑니다.
|
|
32
|
-
|
|
33
|
-
첫째, 저는 도서관 사서가 되고 싶지 않습니다. 때로는 내용을 적고 싶지만, 아직 제목을 정하지 못했거나 특별한 체계를 갖추지 못한 경우가 있습니다. LLM이 자동으로 제목을 생성하고, 요약하고, 분류하고, 탐색하는 등의 정리 작업을 해주길 바랍니다.
|
|
34
|
-
|
|
35
|
-
둘째, 제 서재는 반드시 깨끗해야 합니다. 복잡한 구성 도구를 설정하거나, 복잡한 문서 구성을 꾸미는 것을 원하지 않으며, 복잡한 구조를 좋아하지 않습니다. Docusaurus, VuePress, Astro 같은 도구들의 설정 파일과 프로젝트 구조를 볼 때마다 머리가 아픕니다. 이제 ZEN은 모든 구성을 `.zen` 디렉토리 안에 숨겨 구석으로 치우기로 선택했습니다. 사용자는 글쓰기 내용에만 집중하면 되며, 나머지는 ZEN이 처리합니다. 다른 디렉토리들은 모두 여러분의 글쓰기 공간이며, 마크다운 파일을 자유롭게 구성할 수 있습니다.
|
|
36
|
-
|
|
37
|
-
- **모국어로의 회귀**: 모국어로 글쓰고, 부드러운 다국어 버전 빌드
|
|
38
|
-
|
|
39
|
-
인생은 짧습니다. 저는 번역하기 귀찮습니다. 사람은 모국어를 사용할 때 가장 깊이 생각할 수 있습니다. 하지만 동시에 세계와 연결을 유지하는 것도 필요하며, 다국어 소통을 포기하고 싶지 않습니다. 그래서 저는 모국어로 글을 쓰면서도 더 많은 사람들이 제 내용을 볼 수 있도록 해주는 도구를 원했습니다. 현재의 i18n은 직접 번역해야 할 뿐만 아니라 내용 업데이트도 직접 관리해야 하니 너무 번거롭습니다. 저는 LLM을 사용하여 번역을 도와주도록 선택했고, 많은 시간을 절약하며 한 번의 클릭으로 여러 국가 언어 번역을 완료할 수 있습니다.
|
|
40
|
-
|
|
41
|
-
## 기본 기능
|
|
42
|
-
|
|
43
|
-
1. **정적 사이트 생성**
|
|
44
|
-
- 마크다운 파일이 포함된 임의의 폴더를 정적 HTML 사이트로 빌드합니다.
|
|
45
|
-
|
|
46
|
-
2. **지능형 탐색**
|
|
47
|
-
- 사이트맵과 탐색을 생성합니다. 원본 마크다운 소스 파일의 디렉토리 구조를 유지할 필요가 없으며, 소스 파일을 자유롭게 이동할 수 있습니다.
|
|
48
|
-
|
|
49
|
-
3. **증분 i18n 번역**
|
|
50
|
-
- LLM을 사용한 증분 i18n 번역으로, 사용자가 모국어로 마크다운을 작성하지만 다국어 사용자가 될 수 있도록 합니다.
|
|
51
|
-
|
|
52
|
-
## 디자인 철학
|
|
53
|
-
|
|
54
|
-
- **미니멀리즘**: 최소한의 구성, 최대의 유연성
|
|
55
|
-
- **내용 우선**: 도구 구성이 아닌 글쓰기에 집중
|
|
56
|
-
- **AI 활용**: AI를 활용한 번역 및 내용 구성
|
|
57
|
-
- **다국어 지원**: 다국어 콘텐츠 제작 및 표시 지원
|
|
58
|
-
|
|
59
|
-
## 빠른 시작
|
|
60
|
-
|
|
61
|
-
### 권장 사용 방법
|
|
62
|
-
|
|
63
|
-
**사용자는 마크다운 파일이 포함된 디렉토리로 전환한 후, 아래 명령어를 직접 사용하여 빌드를 시작하는 것을 권장합니다:**
|
|
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` 디렉토리에 출력하도록 강제합니다. 소스 디렉토리와 출력 디렉토리 매개변수 지정을 지원하지 않습니다.
|