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.
- package/.github/workflows/pages.yml +7 -4
- package/.zen/meta.json +40 -118
- package/.zen/src/ar-SA/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/da-DK/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/de-DE/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
- package/.zen/src/de-DE/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
- package/.zen/src/de-DE/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/en-US/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
- package/.zen/src/en-US/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
- package/.zen/src/en-US/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/en-US/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md +63 -0
- package/.zen/src/es-ES/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
- package/.zen/src/es-ES/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
- package/.zen/src/es-ES/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/es-MX/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/fi-FI/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/fr-FR/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
- package/.zen/src/fr-FR/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
- package/.zen/src/fr-FR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/hi-IN/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/id-ID/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/it-IT/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/ja-JP/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +71 -0
- package/.zen/src/ja-JP/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
- package/.zen/src/ja-JP/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/ko-KR/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
- package/.zen/src/ko-KR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/nl-NL/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/no-NO/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/pl-PL/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/pt-BR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/pt-PT/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
- package/.zen/src/pt-PT/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
- package/.zen/src/pt-PT/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/ru-RU/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
- package/.zen/src/ru-RU/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
- package/.zen/src/ru-RU/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/sv-SE/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/th-TH/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/tr-TR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/uk-UA/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/vi-VN/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/zh-Hans/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
- package/.zen/src/zh-Hans/084ef1f6a0167df8621c673c79211309d4af6c588e7bbe3e043f7c244edd0ac6.md +80 -0
- package/.zen/src/zh-Hans/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
- package/.zen/src/zh-Hans/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/.zen/src/zh-Hans/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md +63 -0
- package/.zen/src/zh-Hant/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +71 -0
- package/README.md +30 -34
- package/assets/templates/default/layout.html +58 -3
- package/dist/ai/translateMarkdown.d.ts +1 -1
- package/dist/ai/translateMarkdown.d.ts.map +1 -1
- package/dist/ai/translateMarkdown.js +33 -2
- package/dist/ai/translateMarkdown.js.map +1 -1
- package/dist/languages.d.ts +2 -0
- package/dist/languages.d.ts.map +1 -0
- package/dist/languages.js +37 -0
- package/dist/languages.js.map +1 -0
- package/dist/process/template.js +11 -12
- package/dist/process/template.js.map +1 -1
- package/package.json +2 -2
- package/src/ai/translateMarkdown.ts +33 -2
- package/src/languages.ts +37 -0
- package/src/process/template.ts +12 -12
- package/docs/advanced-usage.md +0 -39
- package/docs/deployment/github-pages.md +0 -107
- package/docs/getting-started.md +0 -26
- package/docs/guides/best-practices.md +0 -175
- package/docs/guides/config.md +0 -48
- package/docs/guides/index.md +0 -51
- package/docs/testing/test-document.md +0 -1
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ZEN - Minimalistinen Markdown + AI -staattinen sivuston rakentaja
|
|
3
|
+
summary: ZEN on AI:ta hyödyntävä staattinen sivuston generoija, joka tukee älykästä luokittelunavigointia ja automaattista inkrementaalista käännöstä. Se mahdollistaa käyttäjän keskittyä äidinkielellä kirjoittamiseen ja yksinkertaistaa konfigurointia ja rakennusprosessia.
|
|
4
|
+
tags:
|
|
5
|
+
- staattinen sivuston generoija
|
|
6
|
+
- Markdown
|
|
7
|
+
- AI
|
|
8
|
+
- monikielinen käännös
|
|
9
|
+
- minimalismi
|
|
10
|
+
- dokumentointityökalu
|
|
11
|
+
- Node.js
|
|
12
|
+
inferred_lang: fi-FI
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Minimalistinen Markdown + AI -staattinen sivuston rakentaja
|
|
16
|
+
|
|
17
|
+
[> Verkkosivuston demo](https://zccz14.github.io/ZEN/)
|
|
18
|
+
|
|
19
|
+
## Perustoiminnot
|
|
20
|
+
|
|
21
|
+
1. 📃 **Staattinen sivuston generointi**: Muunna mikä tahansa git-kansio, joka sisältää Markdown-tiedostoja, staattiseksi HTML-sivustoksi.
|
|
22
|
+
2. 🧭 **Älykäs luokittelunavigointi**: Käytä AI:ta sisällön analysointiin, sivustokartan ja navigoinnin luomiseen. Lähdetiedostojen sijainti ei ole merkityksellinen.
|
|
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 käyttäjä voi olla monikielinen.
|
|
24
|
+
|
|
25
|
+
Miksi olen luonut taas uuden Markdown-staattisen sivuston generoijan? 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. Joskus haluan kirjoittaa jotain sisältöä, mutta en ehkä ole vielä keksinyt sille otsikkoa tai muodostanut selkeää organisointia. Toivoisin, että LLM automaattisesti luo otsikoita, tekee yhteenvetoja, luokittelee ja navigoi sisällön järjestelytyöt.
|
|
32
|
+
|
|
33
|
+
Toiseksi, kirjastoni on puhdistettava siistiksi. En halua monimutkaisia konfigurointityökaluja, sotkea monimutkaisia dokumenttikokoonpanoja tai monimutkaisia rakenteita. Joka kerta kun näen Docusaurus-, VuePress- tai Astro-työkalujen konfiguraatiotiedostot ja projektirakenteet, särkee päätäni. Nyt ZEN valitsee piilottaa kaikki konfiguraatiot `.zen`-hakemistoon, nurkkaan, jotta käyttäjä voi keskittyä vain kirjoittamiseen. Kaikki muut hakemistot ovat sinun kirjoitustilasi, voit järjestellä Markdown-tiedostojasi vapaasti.
|
|
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 toivoisin työkalua, jonka avulla voisin kirjoittaa äidinkielelläni ja samalla saada sisältöni näkyville useammille. Nykyinen i18n vaatii käännösten tekemistä itse ja sisällön päivitysten ylläpidon, mikä on liian työlästä. Valitsen käyttää LLM:ää käännösten tekemiseen, säästän paljon aikaa ja voin suorittaa monikieliset käännökset yhdellä napsautuksella.
|
|
38
|
+
|
|
39
|
+
## Nopea 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 suodatetut tiedostot ohitetaan)
|
|
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 monikielisiä käännöksiä. Käytä nykyistä hakemistoa lähdehakemistona, tuloste `.zen/dist`-hakemistoon.
|
|
58
|
+
|
|
59
|
+
- Voit määrittää tarvittavat kieliversiot käyttämällä `--lang`-parametria useita kertoja (esim. `--lang fi-FI --lang en-US`).
|
|
60
|
+
- Voit määrittää sivuston perus-URL-etuliitteen `--base-url`-parametrilla (esim. GitHub Pages -varaston nimi).
|
|
61
|
+
- Lähdekieltä ei tarvitse konfiguroida, ZEN tunnistaa sen automaattisesti.
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npx zengen@latest build --lang fi-FI --lang en-US
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
**Näytä lisää parametreja tai ohjeita**:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx zengen@latest
|
|
71
|
+
```
|
|
@@ -0,0 +1,73 @@
|
|
|
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.
|
|
@@ -0,0 +1,81 @@
|
|
|
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.
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ZEN - Générateur de site statique minimaliste Markdown + IA
|
|
3
|
+
summary: ZEN est un générateur de site statique intégrant l'IA, prenant en charge la navigation par catégories intelligente et la traduction incrémentale automatique, permettant aux utilisateurs de se concentrer sur l'écriture dans leur langue maternelle et de simplifier les processus de configuration et de construction.
|
|
4
|
+
tags:
|
|
5
|
+
- Générateur de site statique
|
|
6
|
+
- Markdown
|
|
7
|
+
- IA
|
|
8
|
+
- Traduction multilingue
|
|
9
|
+
- Minimalisme
|
|
10
|
+
- Outil de documentation
|
|
11
|
+
- Node.js
|
|
12
|
+
inferred_lang: fr-FR
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Générateur de site statique minimaliste Markdown + IA
|
|
16
|
+
|
|
17
|
+
[> Démo du site web](https://zccz14.github.io/ZEN/)
|
|
18
|
+
|
|
19
|
+
## Fonctionnalités de base
|
|
20
|
+
|
|
21
|
+
1. 📃 **Génération de site statique** : Transforme n'importe quel dossier git contenant des fichiers Markdown en un site HTML statique.
|
|
22
|
+
2. 🧭 **Navigation par catégories intelligente** : Utilise l'IA pour analyser le contenu, générer un plan du site et une navigation, indépendamment de l'emplacement des fichiers sources.
|
|
23
|
+
3. 🌍 **Traduction incrémentale automatique** : Utilise l'IA pour des traductions incrémentielles, permettant aux utilisateurs d'écrire en Markdown dans leur langue maternelle, tout en offrant un contenu multilingue.
|
|
24
|
+
|
|
25
|
+
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 auteurs à l'ère de l'IA :
|
|
26
|
+
|
|
27
|
+
- Retour au contenu : Minimiser les distractions, se concentrer sur l'écriture
|
|
28
|
+
|
|
29
|
+
Ramener la documentation à son essence, ramener l'écriture à la sérénité.
|
|
30
|
+
|
|
31
|
+
Premièrement, je ne veux pas être un bibliothécaire. Parfois, je veux écrire quelque chose, mais je n'ai peut-être pas encore trouvé son titre, ni établi une organisation particulière. J'aimerais que l'IA génère automatiquement les titres, fasse des résumés, des catégorisations, de la navigation et d'autres tâches d'organisation.
|
|
32
|
+
|
|
33
|
+
Deuxièmement, mon espace de travail doit être propre. Je ne veux pas d'outils de construction complexes à configurer, ni de configurations de documentation compliquées, ni de structures alambiquées. 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, permettant à l'utilisateur de se concentrer uniquement sur le contenu de l'écriture, et laissant ZEN gérer le reste. Tous les autres répertoires sont votre espace d'écriture, vous pouvez organiser vos fichiers Markdown comme bon vous semble.
|
|
34
|
+
|
|
35
|
+
- Retour à la langue maternelle : Écrire dans sa langue maternelle, construire des versions multilingues de manière fluide
|
|
36
|
+
|
|
37
|
+
La vie est courte, je n'ai pas envie de 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, il est nécessaire de rester connecté au monde, 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.
|
|
38
|
+
|
|
39
|
+
## Démarrage rapide
|
|
40
|
+
|
|
41
|
+
Prérequis :
|
|
42
|
+
|
|
43
|
+
- [Node.js](https://nodejs.org/) installé (version 18 ou supérieure recommandée, nécessite la commande `npx`)
|
|
44
|
+
- Clé API [OpenAI](https://platform.openai.com/account/api-keys) obtenue, ou clé API compatible avec OpenAI
|
|
45
|
+
- Git installé (pour lister les fichiers Markdown depuis un dépôt Git, en ignorant les fichiers filtrés par les règles `.gitignore`)
|
|
46
|
+
|
|
47
|
+
Tout d'abord, travaillez dans un dossier déjà géré par git :
|
|
48
|
+
|
|
49
|
+
Configurer les variables d'environnement
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
export OPENAI_API_KEY="sk-xxxxxx" # Obligatoire : remplacez par votre clé API OpenAI
|
|
53
|
+
export OPENAI_BASE_URL="https://api.openai.com/v1" # Optionnel, utilise par défaut l'API officielle d'OpenAI
|
|
54
|
+
export OPENAI_MODEL="gpt-3.5-turbo" # Optionnel, utilise par défaut le modèle gpt-3.5-turbo
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Construire le site, avec prise en charge de la traduction multilingue. Utilise le répertoire courant comme source et génère la sortie dans le répertoire `.zen/dist`.
|
|
58
|
+
|
|
59
|
+
- Vous pouvez spécifier les versions linguistiques à générer en utilisant plusieurs fois le paramètre `--lang` (par exemple `--lang fr-FR --lang en-US`).
|
|
60
|
+
- Vous pouvez spécifier le préfixe d'URL de base du site avec le paramètre `--base-url` (par exemple le nom du dépôt sur GitHub Pages).
|
|
61
|
+
- Aucune configuration de la langue source n'est nécessaire, ZEN la détecte automatiquement.
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npx zengen@latest build --lang fr-FR --lang en-US
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
**Voir plus de paramètres ou obtenir de l'aide** :
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx zengen@latest
|
|
71
|
+
```
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ZEN - मिनिमलिस्ट मार्कडाउन + AI स्टैटिक साइट बिल्डर
|
|
3
|
+
summary: ZEN एक AI-संयुक्त स्टैटिक साइट जनरेटर है जो स्मार्ट वर्गीकरण नेविगेशन और स्वचालित इंक्रीमेंटल अनुवाद का समर्थन करता है, जिससे उपयोगकर्ता अपनी मातृभाषा में लिखने पर ध्यान केंद्रित कर सकते हैं, और कॉन्फ़िगरेशन व निर्माण प्रक्रिया को सरल बनाया जा सकता है।
|
|
4
|
+
tags:
|
|
5
|
+
- स्टैटिक साइट जनरेटर
|
|
6
|
+
- मार्कडाउन
|
|
7
|
+
- AI
|
|
8
|
+
- बहुभाषी अनुवाद
|
|
9
|
+
- मिनिमलिज़्म
|
|
10
|
+
- डॉक्यूमेंटेशन टूल
|
|
11
|
+
- Node.js
|
|
12
|
+
inferred_lang: hi-IN
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - मिनिमलिस्ट मार्कडाउन + AI स्टैटिक साइट बिल्डर
|
|
16
|
+
|
|
17
|
+
[> वेबसाइट डेमो](https://zccz14.github.io/ZEN/)
|
|
18
|
+
|
|
19
|
+
## मूलभूत कार्यक्षमताएँ
|
|
20
|
+
|
|
21
|
+
1. 📃 **स्टैटिक साइट जनरेशन**: मार्कडाउन युक्त किसी भी git फ़ोल्डर को एक स्टैटिक HTML साइट में बदल देता है।
|
|
22
|
+
2. 🧭 **स्मार्ट वर्गीकरण नेविगेशन**: AI का उपयोग करके सामग्री का विश्लेषण करता है, साइटमैप और नेविगेशन उत्पन्न करता है, स्रोत फ़ाइलों के स्थान से संवेदनशील नहीं होता।
|
|
23
|
+
3. 🌍 **स्वचालित इंक्रीमेंटल अनुवाद**: AI का उपयोग करके इंक्रीमेंटल अनुवाद करता है, उपयोगकर्ता को मातृभाषा में मार्कडाउन लिखने देता है, लेकिन उपयोगकर्ता बहुभाषी हो सकते हैं।
|
|
24
|
+
|
|
25
|
+
फिर से एक और मार्कडाउन स्टैटिक साइट जनरेटर क्यों बनाया? मैंने AI युग में दोबारा सोचा कि डॉक्यूमेंटेशन टूल लेखकों की बेहतर सेवा कैसे कर सकते हैं:
|
|
26
|
+
|
|
27
|
+
- सामग्री पर वापसी: व्यवधान को न्यूनतम करें, लेखन पर ध्यान केंद्रित करें
|
|
28
|
+
|
|
29
|
+
दस्तावेज़ों को उनके मूल स्वरूप में लौटाएँ, लेखन को शांति में लौटाएँ।
|
|
30
|
+
|
|
31
|
+
पहला, मैं पुस्तकालयाध्यक्ष नहीं बनना चाहता। कभी-कभी मैं कुछ सामग्री लिखना चाहता हूँ, लेकिन हो सकता है मैंने अभी तक इसका शीर्षक नहीं सोचा हो, या विशेष संगठन नहीं बनाया हो। मैं चाहता हूँ कि LLM स्वचालित रूप से मेरे लिए शीर्षक उत्पन्न करे, सारांश बनाए, वर्गीकरण करे, नेविगेशन आदि का प्रबंधन करे।
|
|
32
|
+
|
|
33
|
+
दूसरा, मेरे अध्ययन कक्ष को साफ-सुथरा रखना होगा। मैं जटिल कॉन्फ़िगरेशन वाले बिल्ड टूल, पेचीदा डॉक्यूमेंट कॉन्फ़िगरेशन, या जटिल संरचना नहीं चाहता। हर बार जब मैं Docusaurus, VuePress, Astro जैसे टूल्स के कॉन्फ़िगरेशन फ़ाइलों और प्रोजेक्ट संरचना को देखता हूँ, तो मेरा सिर दर्द करने लगता है। अब, ZEN ने सभी कॉन्फ़िगरेशन को `.zen` डायरेक्टरी में छिपाने, कोने में सरका देने का विकल्प चुना है, उपयोगकर्ता को केवल लेखन सामग्री पर ध्यान केंद्रित करना है, बाकी सब ZEN को सौंप देना है। अन्य सभी डायरेक्टरी आपकी लेखन जगह हैं, आप अपनी मार्कडाउन फ़ाइलों को मनचाहे ढंग से व्यवस्थित कर सकते हैं।
|
|
34
|
+
|
|
35
|
+
- मातृभाषा पर वापसी: मातृभाषा में लिखें, बहुभाषी संस्करणों का सहज निर्माण करें
|
|
36
|
+
|
|
37
|
+
जीवन छोटा है, मैं अनुवाद करने में आलसी हूँ। व्यक्ति अपनी मातृभाषा का उपयोग करते समय ही अपनी सोच की गहराई का पूरा उपयोग कर पाता है। लेकिन साथ ही दुनिया से जुड़े रहना भी ज़रूरी है, मैं बहुभाषी संवाद को छोड़ना नहीं चाहता। इसलिए मैं एक ऐसे टूल की कामना करता हूँ जो मुझे मातृभाषा में लिखने दे, और साथ ही मेरी सामग्री को और लोगों तक पहुँचाए। वर्तमान i18n में न केवल खुद अनुवाद करना पड़ता है, बल्कि सामग्री अपडेट भी खुद से मेंटेन करनी पड़ती है, यह बहुत परेशानी भरा है। मैंने अनुवाद के लिए LLM का उपयोग करने का विकल्प चुना है, इससे मेरा बहुत समय बचता है, और एक क्लिक में कई देशों की भाषाओं में अनुवाद किया जा सकता है।
|
|
38
|
+
|
|
39
|
+
## त्वरित प्रारंभ
|
|
40
|
+
|
|
41
|
+
पूर्वापेक्षाएँ:
|
|
42
|
+
|
|
43
|
+
- [Node.js](https://nodejs.org/) इंस्टॉल है (सुझाई गई संस्करण 18 या उससे ऊपर, npx कमांड उपलब्ध होनी चाहिए)
|
|
44
|
+
- [OpenAI API Key](https://platform.openai.com/account/api-keys) प्राप्त है, या OPENAI-संगत API Key
|
|
45
|
+
- Git इंस्टॉल है (Git से मार्कडाउन फ़ाइलें सूचीबद्ध करने के लिए, .gitignore नियमों द्वारा फ़िल्टर की गई फ़ाइलों को अनदेखा करने के लिए)
|
|
46
|
+
|
|
47
|
+
सबसे पहले, एक ऐसे फ़ोल्डर में काम करें जो पहले से ही git द्वारा प्रबंधित हो:
|
|
48
|
+
|
|
49
|
+
पर्यावरण चर कॉन्फ़िगर करें
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
export OPENAI_API_KEY="sk-xxxxxx" # आवश्यक: कृपया अपने OpenAI API Key से बदलें
|
|
53
|
+
export OPENAI_BASE_URL="https://api.openai.com/v1" # वैकल्पिक, डिफ़ॉल्ट रूप से OpenAI आधिकारिक API का उपयोग करता है
|
|
54
|
+
export OPENAI_MODEL="gpt-3.5-turbo" # वैकल्पिक, डिफ़ॉल्ट रूप से gpt-3.5-turbo मॉडल का उपयोग करता है
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
साइट बनाएँ, बहुभाषी अनुवाद का समर्थन करता है। वर्तमान डायरेक्टरी को स्रोत डायरेक्टरी के रूप में उपयोग करता है, आउटपुट `.zen/dist` डायरेक्टरी में होता है।
|
|
58
|
+
|
|
59
|
+
- `--lang` पैरामीटर का बार-बार उपयोग करके आवश्यक भाषा संस्करण निर्दिष्ट किए जा सकते हैं (उदाहरण: `--lang zh-Hans --lang en-US`)।
|
|
60
|
+
- `--base-url` पैरामीटर द्वारा साइट का आधार URL उपसर्ग निर्दिष्ट किया जा सकता है (उदाहरण: GitHub Pages पर रिपॉजिटरी का नाम)।
|
|
61
|
+
- स्रोत भाषा कॉन्फ़िगर करने की आवश्यकता नहीं है, ZEN स्वचालित रूप से पता लगा लेगा।
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npx zengen@latest build --lang zh-Hans --lang en-US
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
**अधिक पैरामीटर या सहायता देखें**:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx zengen@latest
|
|
71
|
+
```
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ZEN - Pembangun Situs Statis Minimalis Markdown + AI
|
|
3
|
+
summary: ZEN adalah generator situs statis yang menggabungkan AI, mendukung navigasi klasifikasi cerdas dan terjemahan inkremental otomatis, memungkinkan pengguna fokus menulis dalam bahasa ibu mereka, serta menyederhanakan proses konfigurasi dan pembangunan.
|
|
4
|
+
tags:
|
|
5
|
+
- Generator Situs Statis
|
|
6
|
+
- Markdown
|
|
7
|
+
- AI
|
|
8
|
+
- Terjemahan Multibahasa
|
|
9
|
+
- Minimalisme
|
|
10
|
+
- Alat Dokumentasi
|
|
11
|
+
- Node.js
|
|
12
|
+
inferred_lang: id-ID
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Pembangun Situs Statis Minimalis Markdown + AI
|
|
16
|
+
|
|
17
|
+
[> Demo Situs Web](https://zccz14.github.io/ZEN/)
|
|
18
|
+
|
|
19
|
+
## Fitur Dasar
|
|
20
|
+
|
|
21
|
+
1. 📃 **Pembangunan Situs Statis**: Membangun folder git yang berisi Markdown apa pun menjadi situs HTML statis.
|
|
22
|
+
2. 🧭 **Navigasi Klasifikasi Cerdas**: Menggunakan AI untuk analisis konten, menghasilkan peta situs dan navigasi, lokasi file sumber tidak sensitif.
|
|
23
|
+
3. 🌍 **Terjemahan Inkremental Otomatis**: Menggunakan AI untuk terjemahan inkremental, memungkinkan pengguna menulis Markdown dalam bahasa ibu, tetapi pengguna dapat multibahasa.
|
|
24
|
+
|
|
25
|
+
Mengapa membuat generator situs statis Markdown lagi? Saya memikirkan kembali bagaimana alat dokumentasi dapat melayani penulis dengan lebih baik di era AI:
|
|
26
|
+
|
|
27
|
+
- Kembali ke Konten: Minimalkan gangguan, fokus pada penulisan
|
|
28
|
+
|
|
29
|
+
Kembalikan dokumentasi ke esensinya, kembalikan ketenangan dalam menulis.
|
|
30
|
+
|
|
31
|
+
Pertama, saya tidak ingin menjadi pustakawan. Terkadang saya ingin menulis sesuatu, tetapi mungkin saya belum memikirkan judulnya, belum membentuk organisasi yang khusus. Saya berharap LLM akan secara otomatis membantu saya membuat judul, ringkasan, klasifikasi, navigasi, dan pekerjaan pengorganisasian lainnya.
|
|
32
|
+
|
|
33
|
+
Kedua, ruang kerja saya harus bersih. Saya tidak ingin alat pembangun dengan konfigurasi rumit, berurusan dengan konfigurasi dokumen yang kompleks, tidak menyukai struktur yang rumit. Setiap kali saya melihat file konfigurasi dan struktur proyek dari alat-alat seperti Docusaurus, VuePress, Astro, kepala saya pusing. Sekarang, ZEN memilih untuk menyembunyikan semua konfigurasi ke dalam direktori .zen, disapu ke sudut, pengguna hanya perlu fokus pada konten penulisan, sisanya diserahkan kepada ZEN untuk menanganinya. Direktori lainnya adalah ruang penulisan Anda, Anda dapat mengatur file Markdown Anda sesuka hati.
|
|
34
|
+
|
|
35
|
+
- Kembali ke Bahasa Ibu: Menulis dalam bahasa ibu, membangun versi multibahasa dengan lancar
|
|
36
|
+
|
|
37
|
+
Hidup ini singkat, saya malas menerjemahkan. Saat menggunakan bahasa ibu, seseorang dapat mengungkapkan kedalaman pemikirannya dengan paling baik. Tetapi tetap terhubung dengan dunia juga diperlukan, saya tidak ingin melepaskan komunikasi multibahasa. Oleh karena itu, saya berharap ada alat yang memungkinkan saya menulis dalam bahasa ibu, sekaligus memungkinkan lebih banyak orang melihat konten saya. i18n saat ini tidak hanya mengharuskan diri sendiri menerjemahkan, tetapi juga harus memelihara pembaruan konten sendiri, terlalu merepotkan. Saya memilih menggunakan LLM untuk membantu saya menerjemahkan, menghemat banyak waktu saya, dan dapat menyelesaikan terjemahan multibahasa dengan satu klik.
|
|
38
|
+
|
|
39
|
+
## Memulai Cepat
|
|
40
|
+
|
|
41
|
+
Prasyarat:
|
|
42
|
+
|
|
43
|
+
- Sudah menginstal [Node.js](https://nodejs.org/) (disarankan versi 18 ke atas, perlu perintah npx)
|
|
44
|
+
- Sudah mendapatkan [OpenAI API Key](https://platform.openai.com/account/api-keys), atau API Key yang kompatibel dengan OPENAI
|
|
45
|
+
- Sudah menginstal Git (untuk mendaftar file Markdown dari Git, mengabaikan file yang difilter oleh aturan .gitignore)
|
|
46
|
+
|
|
47
|
+
Pertama, bekerja di dalam folder yang sudah dikelola oleh git:
|
|
48
|
+
|
|
49
|
+
Konfigurasi variabel lingkungan
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
export OPENAI_API_KEY="sk-xxxxxx" # Wajib: Ganti dengan OpenAI API Key Anda
|
|
53
|
+
export OPENAI_BASE_URL="https://api.openai.com/v1" # Opsional, default menggunakan API resmi OpenAI
|
|
54
|
+
export OPENAI_MODEL="gpt-3.5-turbo" # Opsional, default menggunakan model gpt-3.5-turbo
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Bangun situs, mendukung terjemahan multibahasa. Gunakan direktori saat ini sebagai direktori sumber, output ke direktori `.zen/dist`.
|
|
58
|
+
|
|
59
|
+
- Dapat menentukan versi bahasa yang perlu dibuat dengan menggunakan parameter `--lang` beberapa kali (misalnya `--lang id-ID --lang en-US`).
|
|
60
|
+
- Dapat menentukan prefiks URL dasar situs dengan parameter `--base-url` (misalnya nama repositori di GitHub Pages).
|
|
61
|
+
- Tidak perlu mengonfigurasi bahasa sumber, ZEN akan mendeteksi secara otomatis.
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npx zengen@latest build --lang id-ID --lang en-US
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
**Lihat parameter atau bantuan lebih lanjut**:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx zengen@latest
|
|
71
|
+
```
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ZEN - Generatore di Siti Statici Minimalista Markdown + AI
|
|
3
|
+
summary: ZEN è un generatore di siti statici integrato con l'IA, che supporta la navigazione intelligente per categorie e la traduzione incrementale automatica, permettendo agli utenti di concentrarsi sulla scrittura nella propria lingua madre e semplificando i processi di configurazione e build.
|
|
4
|
+
tags:
|
|
5
|
+
- Generatore di Siti Statici
|
|
6
|
+
- Markdown
|
|
7
|
+
- AI
|
|
8
|
+
- Traduzione Multilingue
|
|
9
|
+
- Minimalismo
|
|
10
|
+
- Strumenti di Documentazione
|
|
11
|
+
- Node.js
|
|
12
|
+
inferred_lang: it-IT
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Generatore di Siti Statici Minimalista Markdown + AI
|
|
16
|
+
|
|
17
|
+
[> Demo del Sito Web](https://zccz14.github.io/ZEN/)
|
|
18
|
+
|
|
19
|
+
## Funzionalità di Base
|
|
20
|
+
|
|
21
|
+
1. 📃 **Generazione di Siti Statici**: Trasforma qualsiasi cartella git contenente file Markdown in un sito HTML statico.
|
|
22
|
+
2. 🧭 **Navigazione Intelligente per Categorie**: Utilizza l'IA per analizzare i contenuti, generare una mappa del sito e una navigazione, indipendentemente dalla posizione dei file sorgente.
|
|
23
|
+
3. 🌍 **Traduzione Incrementale Automatica**: Utilizza l'IA per la traduzione incrementale, permettendo agli utenti di scrivere in Markdown nella propria lingua madre, ma supportando comunque un pubblico multilingue.
|
|
24
|
+
|
|
25
|
+
Perché creare un altro generatore di siti statici da Markdown? Ho ripensato a come gli strumenti di documentazione possano servire meglio gli scrittori nell'era dell'IA:
|
|
26
|
+
|
|
27
|
+
- Ritorno al Contenuto: Minimizzare le distrazioni, concentrarsi sulla scrittura
|
|
28
|
+
|
|
29
|
+
Far tornare la documentazione alla sua essenza, far tornare la scrittura alla sua tranquillità.
|
|
30
|
+
|
|
31
|
+
Primo, non voglio fare il bibliotecario. A volte voglio annotare qualcosa, ma potrei non aver ancora pensato a un titolo o a una struttura organizzativa precisa. Vorrei che un LLM generasse automaticamente titoli, riassunti, categorie, navigazione e altre operazioni di organizzazione.
|
|
32
|
+
|
|
33
|
+
Secondo, il mio studio deve essere ordinato. Non voglio strumenti di build con configurazioni complesse, configurazioni di documentazione intricate, né strutture complicate. Ogni volta che vedo i file di configurazione e le strutture di progetto di strumenti come Docusaurus, VuePress, Astro, mi viene il mal di testa. Ora, ZEN sceglie di nascondere tutte le configurazioni nella directory `.zen`, spazzandole in un angolo. L'utente deve solo concentrarsi sulla scrittura dei contenuti, il resto lo gestisce ZEN. Tutte le altre directory sono il vostro spazio di scrittura, potete organizzare i vostri file Markdown come preferite.
|
|
34
|
+
|
|
35
|
+
- Ritorno alla Lingua Madre: Scrivere nella propria lingua madre, costruire versioni multilingue senza intoppi
|
|
36
|
+
|
|
37
|
+
La vita è breve, non ho voglia di tradurre. Quando si usa la propria lingua madre, si esprime al meglio la profondità del proprio pensiero. Ma allo stesso tempo, è necessario rimanere connessi con il mondo, non voglio rinunciare alla comunicazione multilingue. Quindi desidero uno strumento che mi permetta di scrivere nella mia lingua madre, ma che permetta anche a più persone di vedere i miei contenuti. L'i18n attuale richiede non solo di tradurre da soli, ma anche di mantenere aggiornati i contenuti, è troppo complicato. Ho scelto di usare un LLM per aiutarmi con le traduzioni, risparmiandomi molto tempo e permettendomi di completare le traduzioni in più lingue con un clic.
|
|
38
|
+
|
|
39
|
+
## Guida Rapida
|
|
40
|
+
|
|
41
|
+
Prerequisiti:
|
|
42
|
+
|
|
43
|
+
- [Node.js](https://nodejs.org/) installato (si consiglia versione 18 o superiore, deve avere il comando `npx`)
|
|
44
|
+
- Ottenuta una [OpenAI API Key](https://platform.openai.com/account/api-keys), o una API Key compatibile con OPENAI
|
|
45
|
+
- Git installato (per elencare i file Markdown da una repository Git, ignorando i file filtrati dalle regole `.gitignore`)
|
|
46
|
+
|
|
47
|
+
Innanzitutto, lavora in una cartella già gestita da git:
|
|
48
|
+
|
|
49
|
+
Configura le variabili d'ambiente
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
export OPENAI_API_KEY="sk-xxxxxx" # Obbligatorio: sostituisci con la tua OpenAI API Key
|
|
53
|
+
export OPENAI_BASE_URL="https://api.openai.com/v1" # Opzionale, di default usa l'API ufficiale di OpenAI
|
|
54
|
+
export OPENAI_MODEL="gpt-3.5-turbo" # Opzionale, di default usa il modello gpt-3.5-turbo
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Costruisci il sito, supportando la traduzione multilingue. Usa la directory corrente come sorgente, l'output va nella directory `.zen/dist`.
|
|
58
|
+
|
|
59
|
+
- Puoi specificare le versioni linguistiche da generare usando più volte il parametro `--lang` (es. `--lang it-IT --lang en-US`).
|
|
60
|
+
- Puoi specificare il prefisso dell'URL base del sito con il parametro `--base-url` (es. il nome della repository su GitHub Pages).
|
|
61
|
+
- Non è necessario configurare la lingua sorgente, ZEN la rileverà automaticamente.
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npx zengen@latest build --lang it-IT --lang en-US
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
**Visualizza più parametri o la guida**:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx zengen@latest
|
|
71
|
+
```
|
|
@@ -0,0 +1,71 @@
|
|
|
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` ディレクトリに出力することを強制します。ソースディレクトリと出力ディレクトリのパラメータ指定はサポートしていません。
|