zengen 0.2.6 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.zen/meta.json +24 -7
- package/.zen/src/ar-SA/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/ar-SA/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/ar-SA/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/da-DK/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/da-DK/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/da-DK/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/de-DE/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/de-DE/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/de-DE/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/en-US/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/en-US/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/en-US/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/es-ES/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/es-ES/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/es-ES/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/es-MX/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/es-MX/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/es-MX/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/fi-FI/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/fi-FI/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/fi-FI/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/fr-FR/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/fr-FR/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/fr-FR/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/hi-IN/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/hi-IN/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/hi-IN/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/id-ID/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/id-ID/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/id-ID/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/it-IT/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/it-IT/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/it-IT/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/ja-JP/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/ja-JP/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/ja-JP/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/ko-KR/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/ko-KR/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/ko-KR/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/nl-NL/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/nl-NL/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/nl-NL/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/no-NO/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/no-NO/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/no-NO/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/pl-PL/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/pl-PL/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/pl-PL/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/pt-BR/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/pt-BR/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/pt-BR/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/pt-PT/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/pt-PT/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/pt-PT/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/ru-RU/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/ru-RU/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/ru-RU/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/sv-SE/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/sv-SE/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/sv-SE/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/th-TH/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/th-TH/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/th-TH/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/tr-TR/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/tr-TR/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/tr-TR/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/uk-UA/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/uk-UA/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/uk-UA/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/vi-VN/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +121 -0
- package/.zen/src/vi-VN/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/vi-VN/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/.zen/src/zh-Hans/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +123 -0
- package/.zen/src/zh-Hans/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +74 -0
- package/.zen/src/zh-Hans/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +75 -0
- package/.zen/src/zh-Hant/50bf41ac6fd8ec8cd6481fd1114aaf00abed0461fc8e8c81cc0373d38ffa835c.md +123 -0
- package/.zen/src/zh-Hant/6e7ca196ba51235db30218cf9b28f92d35937b09a22411062be088a0086b29ed.md +70 -0
- package/.zen/src/zh-Hant/98a9dd72146a69d155030cb7286ea2d10e0521451de9754cbdfcde46c46f2c71.md +71 -0
- package/README.md +1 -2
- package/assets/templates/default/layout.html +82 -0
- package/dist/build/pipeline.d.ts.map +1 -1
- package/dist/build/pipeline.js +0 -1
- package/dist/build/pipeline.js.map +1 -1
- package/dist/cli.js +0 -2
- package/dist/cli.js.map +1 -1
- package/dist/process/template.d.ts.map +1 -1
- package/dist/process/template.js +3 -4
- package/dist/process/template.js.map +1 -1
- package/dist/types.d.ts +0 -1
- package/dist/types.d.ts.map +1 -1
- package/dist/utils/convertMarkdownToHtml.d.ts.map +1 -1
- package/dist/utils/convertMarkdownToHtml.js +75 -22
- package/dist/utils/convertMarkdownToHtml.js.map +1 -1
- package/docs/test-mermaid.md +105 -0
- package/package.json +2 -2
- package/src/build/pipeline.ts +0 -1
- package/src/cli.ts +0 -2
- package/src/process/template.ts +3 -9
- package/src/types.ts +0 -1
- package/src/utils/convertMarkdownToHtml.ts +80 -21
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
'title': 'ZEN - Minimalistische Markdown + AI Statische Site Generator'
|
|
3
|
+
'summary': 'ZEN is een statische site generator met AI-functionaliteiten, speciaal ontworpen voor Markdown-documenten. Het stelt gebruikers in staat om een Git-map met Markdown-bestanden om te zetten in een statische HTML-site, zonder complexe configuratie; alle instellingen zijn verborgen in de .zen-map. Kernfuncties zijn onder meer intelligente categorisatie en navigatie (gebruikmakend van AI om inhoud te analyseren en een sitemap te genereren), automatische incrementele vertaling (ondersteunt meertalige versies, gebruikers kunnen in hun moedertaal schrijven, AI verzorgt de vertaling), en een schrijfervaring met minimale afleiding. De snelstartgids vereist de installatie van Node.js, het verkrijgen van een OpenAI API Key en Git, het bouwen van de site via de commandoregel, en ondersteunt het specificeren van taal en basis-URL.'
|
|
4
|
+
'tags':
|
|
5
|
+
- 'Statische Site Generator'
|
|
6
|
+
- 'Markdown'
|
|
7
|
+
- 'AI'
|
|
8
|
+
- 'Meertalige Vertaling'
|
|
9
|
+
- 'Minimalisme'
|
|
10
|
+
- 'Documentatietool'
|
|
11
|
+
- 'Git'
|
|
12
|
+
'inferred_lang': 'zh-Hans'
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Minimalistische Markdown + AI Statische Site Generator
|
|
16
|
+
|
|
17
|
+
[> Website Demo](https://zen.zccz14.com/)
|
|
18
|
+
|
|
19
|
+
## Basisfunctionaliteiten
|
|
20
|
+
|
|
21
|
+
1. 📃 **Statische Site Generatie**: Bouw een willekeurige Git-map met Markdown-bestanden om naar een statische HTML-site.
|
|
22
|
+
2. 🧭 **Intelligente Categorisatie en Navigatie**: Gebruik AI voor inhoudsanalyse, genereer een sitemap en navigatie, ongeacht de locatie van de bronbestanden.
|
|
23
|
+
3. 🌍 **Automatische Incrementele Vertaling**: Gebruik AI voor incrementele vertaling, zodat gebruikers in hun moedertaal Markdown kunnen schrijven, maar de site meertalig kan zijn.
|
|
24
|
+
|
|
25
|
+
Waarom nog een Markdown statische site generator? Ik heb opnieuw nagedacht over hoe documentatietools in het AI-tijdperk schrijvers beter kunnen dienen:
|
|
26
|
+
|
|
27
|
+
- Terug naar inhoud: Minimale afleiding, focus op schrijven
|
|
28
|
+
|
|
29
|
+
Laat documentatie terugkeren naar de essentie, laat schrijven terugkeren naar rust.
|
|
30
|
+
|
|
31
|
+
Ten eerste, ik wil geen bibliothecaris zijn. Soms wil ik iets opschrijven, maar ik heb misschien nog geen titel bedacht of een duidelijke structuur gevormd. Ik hoop dat LLM automatisch titels voor me genereert, samenvattingen maakt, categoriseert, navigatie regelt en ander organisatiewerk doet.
|
|
32
|
+
|
|
33
|
+
Ten tweede, mijn werkkamer moet opgeruimd zijn. Ik wil geen complexe bouwtools configureren, geen ingewikkelde documentatie-instellingen uitzoeken, en houd niet van complexe structuren. Elke keer als ik de configuratiebestanden en projectstructuren van tools zoals Docusaurus, VuePress, Astro zie, krijg ik hoofdpijn. Nu kiest ZEN ervoor om alle configuratie te verbergen in de .zen-map, weggeveegd in een hoekje. Gebruikers hoeven zich alleen te concentreren op het schrijven van inhoud, de rest laat ZEN afhandelen. Alle andere mappen zijn uw schrijfruimte, u kunt uw Markdown-bestanden vrij organiseren.
|
|
34
|
+
|
|
35
|
+
- Terug naar moedertaal: Schrijf in je moedertaal, bouw soepel meertalige versies
|
|
36
|
+
|
|
37
|
+
Het leven is kort, ik heb geen zin om te vertalen. Mensen kunnen hun denkdiepte het beste benutten wanneer ze hun moedertaal gebruiken. Maar tegelijkertijd is verbinding met de wereld noodzakelijk, ik wil meertalige communicatie niet opgeven. Daarom wilde ik een tool die me in staat stelt in mijn moedertaal te schrijven, terwijl meer mensen mijn inhoud kunnen zien. De huidige i18n vereist niet alleen zelfvertaling, maar ook zelfonderhoud van inhoudsupdates, dat is te veel gedoe. Ik kies ervoor om LLM te gebruiken om voor mij te vertalen, wat me veel tijd bespaart en meertalige vertalingen met één klik mogelijk maakt.
|
|
38
|
+
|
|
39
|
+
## Snelstart
|
|
40
|
+
|
|
41
|
+
Vereisten:
|
|
42
|
+
|
|
43
|
+
- [Node.js](https://nodejs.org/) geïnstalleerd (aanbevolen versie 18 of hoger, npx-commando vereist)
|
|
44
|
+
- Een [OpenAI API Key](https://platform.openai.com/account/api-keys) verkregen, of een OPENAI-compatibele API Key
|
|
45
|
+
- Git geïnstalleerd (om Markdown-bestanden uit Git op te lijsten, bestanden gefilterd door .gitignore-regels te negeren)
|
|
46
|
+
|
|
47
|
+
Werk eerst in een map die al door Git wordt beheerd:
|
|
48
|
+
|
|
49
|
+
Configureer omgevingsvariabelen
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
export OPENAI_API_KEY="sk-xxxxxx" # Verplicht: Vervang door uw OpenAI API Key
|
|
53
|
+
export OPENAI_BASE_URL="https://api.openai.com/v1" # Optioneel, gebruikt standaard het officiële OpenAI API
|
|
54
|
+
export OPENAI_MODEL="gpt-3.5-turbo" # Optioneel, gebruikt standaard het gpt-3.5-turbo model
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Bouw de site, ondersteunt meertalige vertaling. Gebruik de huidige map als bronmap, uitvoer naar de `.zen/dist` map.
|
|
58
|
+
|
|
59
|
+
- U kunt meerdere keren de `--lang` parameter gebruiken om de gewenste taalversies op te geven (bijv. `--lang zh-Hans --lang en-US`).
|
|
60
|
+
- U kunt de `--base-url` parameter gebruiken om het basis-URL-voorvoegsel van de site op te geven (bijv. de repositorynaam op GitHub Pages).
|
|
61
|
+
- Bron taal hoeft niet geconfigureerd te worden, ZEN detecteert dit automatisch.
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npx zengen@latest build --lang zh-Hans --lang en-US
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
**Meer parameters of hulp bekijken**:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx zengen@latest
|
|
71
|
+
```
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
---
|
|
2
|
+
'title': 'Mermaid-diagramtestdokument'
|
|
3
|
+
'summary': 'Dette dokumentet er en testfil for å validere Mermaid-diagramgjengivelsesfunksjonen i ZEN. Den inneholder eksempler på flere Mermaid-diagramtyper, som flytskjemaer, sekvensdiagrammer, Gantt-diagrammer, klassediagrammer, tilstandsdiagrammer og kakediagrammer, og inkluderer en testsyntaksfeil for å sjekke feilmeldinger. Dokumentet er designet for å vise at Mermaid-integrasjonen i ZEN fungerer som forventet.'
|
|
4
|
+
'tags':
|
|
5
|
+
- 'Mermaid'
|
|
6
|
+
- 'diagramtesting'
|
|
7
|
+
- 'ZEN'
|
|
8
|
+
- 'flytskjema'
|
|
9
|
+
- 'sekvensdiagram'
|
|
10
|
+
- 'Gantt-diagram'
|
|
11
|
+
- 'klassediagram'
|
|
12
|
+
- 'tilstandsdiagram'
|
|
13
|
+
'inferred_date': '2024-01-01'
|
|
14
|
+
'inferred_lang': 'no-NO'
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# Mermaid-diagramtesting
|
|
18
|
+
|
|
19
|
+
Dette er en testfil for å validere Mermaid-diagramgjengivelsesfunksjonen i ZEN.
|
|
20
|
+
|
|
21
|
+
## Eksempel på flytskjema
|
|
22
|
+
|
|
23
|
+
```mermaid
|
|
24
|
+
graph TD
|
|
25
|
+
A[Start] --> B{Fortsette?}
|
|
26
|
+
B -->|Ja| C[Utfør handling]
|
|
27
|
+
B -->|Nei| D[Avslutt]
|
|
28
|
+
C --> E[Sjekk resultat]
|
|
29
|
+
E --> F{Vellykket?}
|
|
30
|
+
F -->|Ja| G[Fullført]
|
|
31
|
+
F -->|Nei| H[Prøv på nytt]
|
|
32
|
+
H --> C
|
|
33
|
+
G --> D
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Eksempel på sekvensdiagram
|
|
37
|
+
|
|
38
|
+
```mermaid
|
|
39
|
+
sequenceDiagram
|
|
40
|
+
participant Bruker
|
|
41
|
+
participant System
|
|
42
|
+
participant Database
|
|
43
|
+
|
|
44
|
+
Bruker->>System: Send forespørsel
|
|
45
|
+
System->>Database: Spør etter data
|
|
46
|
+
Database-->>System: Returner resultat
|
|
47
|
+
System-->>Bruker: Vis resultat
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Eksempel på Gantt-diagram
|
|
51
|
+
|
|
52
|
+
```mermaid
|
|
53
|
+
gantt
|
|
54
|
+
title Prosjekttidsplan
|
|
55
|
+
dateFormat YYYY-MM-DD
|
|
56
|
+
section Design
|
|
57
|
+
Kravanalyse :done, des1, 2024-01-01, 7d
|
|
58
|
+
Prototypedesign :active, des2, 2024-01-08, 5d
|
|
59
|
+
Detaljert design: des3, after des2, 5d
|
|
60
|
+
section Utvikling
|
|
61
|
+
Frontend-utvikling : dev1, after des3, 10d
|
|
62
|
+
Backend-utvikling : dev2, after des3, 15d
|
|
63
|
+
section Testing
|
|
64
|
+
Enhetstesting : test1, after dev1, 5d
|
|
65
|
+
Integrasjonstesting: test2, after dev2, 5d
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Eksempel på klassediagram
|
|
69
|
+
|
|
70
|
+
```mermaid
|
|
71
|
+
classDiagram
|
|
72
|
+
class Animal {
|
|
73
|
+
+String name
|
|
74
|
+
+int age
|
|
75
|
+
+void eat()
|
|
76
|
+
+void sleep()
|
|
77
|
+
}
|
|
78
|
+
class Dog {
|
|
79
|
+
+void bark()
|
|
80
|
+
}
|
|
81
|
+
class Cat {
|
|
82
|
+
+void meow()
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
Animal <|-- Dog
|
|
86
|
+
Animal <|-- Cat
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Eksempel på tilstandsdiagram
|
|
90
|
+
|
|
91
|
+
```mermaid
|
|
92
|
+
stateDiagram-v2
|
|
93
|
+
[*] --> Inaktiv
|
|
94
|
+
Inaktiv --> Behandler : Start behandling
|
|
95
|
+
Behandler --> Vellykket : Behandling vellykket
|
|
96
|
+
Behandler --> Feil : Behandling mislyktes
|
|
97
|
+
Vellykket --> [*]
|
|
98
|
+
Feil --> [*]
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
## Eksempel på kakediagram
|
|
102
|
+
|
|
103
|
+
```mermaid
|
|
104
|
+
pie title Nettleserbruk
|
|
105
|
+
"Chrome" : 65.2
|
|
106
|
+
"Firefox" : 15.3
|
|
107
|
+
"Safari" : 12.5
|
|
108
|
+
"Edge" : 5.2
|
|
109
|
+
"Annet" : 1.8
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## Testsyntaksfeil (skal vise feilmelding)
|
|
113
|
+
|
|
114
|
+
```mermaid
|
|
115
|
+
graph TD
|
|
116
|
+
A --> B
|
|
117
|
+
// Mangler pildedefinisjon her
|
|
118
|
+
C --> D
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
Denne testfilen inneholder flere Mermaid-diagramtyper for å validere at Mermaid-integrasjonen i ZEN fungerer som forventet.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
'title': 'ZEN - Minimalistisk Markdown + AI-statisk nettstedbygger'
|
|
3
|
+
'summary': 'ZEN er en statisk nettstedgenerator med AI-integrasjon som fokuserer på å forenkle dokumentasjon og byggeprosessen. Den lar brukere opprette statiske HTML-nettsteder fra git-styrte mapper ved hjelp av Markdown, uten kompleks konfigurasjon – alle innstillinger er skjult i .zen-mappen. Kjernefunksjoner inkluderer intelligent kategorinavigasjon (genererer nettstedskart via AI-analyse), automatisk inkrementell oversettelse (støtter flerspråklige versjoner, brukere kan skrive på morsmålet mens AI håndterer oversettelsen), og en minimalt forstyrrende skriveopplevelse. Verktøyet krever Node.js, OpenAI API-nøkkel og Git, bygges raskt via kommandolinje, og støtter språkparametere som zh-Hans og en-US.'
|
|
4
|
+
'tags':
|
|
5
|
+
- 'Statisk nettstedgenerator'
|
|
6
|
+
- 'Markdown'
|
|
7
|
+
- 'AI'
|
|
8
|
+
- 'Flerspråklig oversettelse'
|
|
9
|
+
- 'Minimalisme'
|
|
10
|
+
- 'Dokumentasjonsverktøy'
|
|
11
|
+
- 'ZEN'
|
|
12
|
+
'inferred_lang': 'zh-Hans'
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Minimalistisk Markdown + AI-statisk nettstedbygger
|
|
16
|
+
|
|
17
|
+
[> Nettsteddemo](https://zen.zccz14.com/)
|
|
18
|
+
|
|
19
|
+
## Grunnleggende funksjoner
|
|
20
|
+
|
|
21
|
+
1. 📃 **Statisk nettstedgenerering**: Bygg et statisk HTML-nettsted fra en hvilken som helst git-mappe som inneholder Markdown-filer.
|
|
22
|
+
2. 🧭 **Intelligent kategorinavigasjon**: Bruker AI til å analysere innhold og generere nettstedskart og navigasjon, uavhengig av kildefilenes plassering.
|
|
23
|
+
3. 🌍 **Automatisk inkrementell oversettelse**: Bruker AI til inkrementell oversettelse, slik at brukere kan skrive Markdown på morsmålet, mens nettstedet blir flerspråklig.
|
|
24
|
+
|
|
25
|
+
Hvorfor lagde jeg enda en Markdown-statisk nettstedgenerator? Jeg har tenkt på hvordan dokumentasjonsverktøy i AI-tiden bedre kan tjene skribenter:
|
|
26
|
+
|
|
27
|
+
- Tilbake til innholdet: Minimal forstyrrelse, fokus på skriving
|
|
28
|
+
|
|
29
|
+
La dokumentasjonen vende tilbake til essensen, og la skrivingen bli rolig.
|
|
30
|
+
|
|
31
|
+
For det første vil jeg ikke være bibliotekar. Noen ganger vil jeg skrive ned noe, men jeg har kanskje ikke tenkt ut en tittel ennå, eller organisert det godt. Jeg ønsker at LLM automatisk skal generere titler, lage sammendrag, kategorisere og lage navigasjon for meg.
|
|
32
|
+
|
|
33
|
+
For det andre må kontoret mitt være rent. Jeg vil ikke ha komplekse byggeverktøy med innviklede konfigurasjoner, eller krøkkete dokumentasjonsstrukturer. Hver gang jeg ser konfigurasjonsfiler og prosjektstrukturer fra Docusaurus, VuePress eller Astro, får jeg hodepine. Nå har ZEN valgt å skjule all konfigurasjon i .zen-mappen, gjemt bort i et hjørne. Brukeren trenger bare å fokusere på å skrive innhold, resten håndterer ZEN. Alle andre mapper er din skriveplass, du kan organisere Markdown-filene dine som du vil.
|
|
34
|
+
|
|
35
|
+
- Tilbake til morsmålet: Skriv på morsmålet, bygg flerspråklige versjoner sømløst
|
|
36
|
+
|
|
37
|
+
Livet er for kort til at jeg gidder å oversette. Når man bruker morsmålet, kan man tenke på sitt dypeste. Men det er også nødvendig å forbli tilkoblet verden, og jeg vil ikke gi opp flerspråklig kommunikasjon. Derfor ønsker jeg et verktøy som lar meg skrive på morsmålet, samtidig som flere kan se innholdet mitt. Dagens i18n krever at man oversetter selv og vedlikeholder oppdateringer, det er for mye arbeid. Jeg velger å bruke LLM til å oversette for meg, det sparer mye tid og gjør flerspråklige oversettelser til én knappetrykking.
|
|
38
|
+
|
|
39
|
+
## Kom i gang raskt
|
|
40
|
+
|
|
41
|
+
Forutsetninger:
|
|
42
|
+
|
|
43
|
+
- [Node.js](https://nodejs.org/) er installert (anbefalt versjon 18 eller nyere, må ha npx-kommandoen)
|
|
44
|
+
- Du har en [OpenAI API-nøkkel](https://platform.openai.com/account/api-keys), eller en OPENAI-kompatibel API-nøkkel
|
|
45
|
+
- Git er installert (brukes til å liste Markdown-filer fra Git, ignorerer filer filtrert av .gitignore-regler)
|
|
46
|
+
|
|
47
|
+
Først, arbeid i en mappe som allerede er styrt av Git:
|
|
48
|
+
|
|
49
|
+
Konfigurer miljøvariabler
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
export OPENAI_API_KEY="sk-xxxxxx" # Påkrevd: erstatt med din OpenAI API-nøkkel
|
|
53
|
+
export OPENAI_BASE_URL="https://api.openai.com/v1" # Valgfritt, bruker offisiell OpenAI API som standard
|
|
54
|
+
export OPENAI_MODEL="gpt-3.5-turbo" # Valgfritt, bruker gpt-3.5-turbo-modellen som standard
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Bygg nettstedet, støtter flerspråklig oversettelse. Bruker gjeldende mappe som kilde, output til `.zen/dist`-mappen.
|
|
58
|
+
|
|
59
|
+
- Du kan spesifisere språkversjoner som skal genereres ved å bruke `--lang`-parameteren flere ganger (f.eks. `--lang zh-Hans --lang en-US`).
|
|
60
|
+
- Kilde språk trenger ikke konfigureres, ZEN oppdager det automatisk.
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
npx zengen@latest build --lang zh-Hans --lang en-US
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
**Se flere parametere eller få hjelp**:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
npx zengen@latest
|
|
70
|
+
```
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
'title': 'ZEN - Minimalistisk Markdown + AI-statisk nettstedbygger'
|
|
3
|
+
'summary': 'ZEN er en statisk nettstedgenerator med AI-funksjoner, spesielt designet for Markdown-dokumenter. Den lar brukere konvertere en Git-mappe som inneholder Markdown-filer til et statisk HTML-nettsted uten kompleks konfigurasjon, med alle innstillinger skjult i .zen-katalogen. Kjernefunksjoner inkluderer intelligent kategorinavigasjon (bruker AI til å analysere innhold og generere nettstedskart), automatisk inkrementell oversettelse (støtter flerspråklige versjoner, brukere kan skrive på morsmålet, AI håndterer oversettelse), og en minimalt forstyrrende skriveopplevelse. Hurtigstartveiledningen krever installasjon av Node.js, anskaffelse av OpenAI API-nøkkel og Git, bygging av nettstedet via kommandolinjen, med støtte for spesifisering av språk og basis-URL.'
|
|
4
|
+
'tags':
|
|
5
|
+
- 'Statisk nettstedgenerator'
|
|
6
|
+
- 'Markdown'
|
|
7
|
+
- 'AI'
|
|
8
|
+
- 'Flerspråklig oversettelse'
|
|
9
|
+
- 'Minimalisme'
|
|
10
|
+
- 'Dokumentverktøy'
|
|
11
|
+
- 'Git'
|
|
12
|
+
'inferred_lang': 'zh-Hans'
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Minimalistisk Markdown + AI-statisk nettstedbygger
|
|
16
|
+
|
|
17
|
+
[> Nettsteddemo](https://zen.zccz14.com/)
|
|
18
|
+
|
|
19
|
+
## Grunnleggende funksjoner
|
|
20
|
+
|
|
21
|
+
1. 📃 **Statisk nettstedgenerering**: Bygg en hvilken som helst Git-mappe som inneholder Markdown til et statisk HTML-nettsted.
|
|
22
|
+
2. 🧭 **Intelligent kategorinavigasjon**: Bruker AI til innholdsanalyse, genererer nettstedskart og navigasjon, uavhengig av kildefilenes plassering.
|
|
23
|
+
3. 🌍 **Automatisk inkrementell oversettelse**: Bruker AI til inkrementell oversettelse, slik at brukere kan skrive Markdown på morsmålet, men nettstedet kan være flerspråklig.
|
|
24
|
+
|
|
25
|
+
Hvorfor lagde jeg enda en Markdown-statisk nettstedgenerator? Jeg har tenkt på nytt over hvordan dokumentverktøy i AI-tiden bedre kan tjene skribenter:
|
|
26
|
+
|
|
27
|
+
- Tilbake til innholdet: Minimal forstyrrelse, fokus på skriving
|
|
28
|
+
|
|
29
|
+
La dokumenter gå tilbake til essensen, la skrivingen gå tilbake til ro.
|
|
30
|
+
|
|
31
|
+
For det første vil jeg ikke være bibliotekar. Noen ganger vil jeg skrive ned noe, men jeg har kanskje ikke tenkt ut tittelen ennå, eller organisert det spesielt. Jeg ønsker at LLM automatisk skal hjelpe meg med å generere titler, lage sammendrag, kategorisere, navigere og andre organiseringsoppgaver.
|
|
32
|
+
|
|
33
|
+
For det andre må mitt skrivebord være rent. Jeg vil ikke ha komplekse konfigurasjonsverktøy, krangle med innviklede dokumentoppsett, eller liker komplekse strukturer. Hver gang jeg ser konfigurasjonsfiler og prosjektstrukturer fra verktøy som Docusaurus, VuePress, Astro, får jeg hodepine. Nå velger ZEN å skjule all konfigurasjon i .zen-katalogen, feie den bort i et hjørne. Brukeren trenger bare å fokusere på å skrive innhold, resten håndteres av ZEN. Alle andre kataloger er ditt skriveområde, du kan organisere Markdown-filene dine som du vil.
|
|
34
|
+
|
|
35
|
+
- Tilbake til morsmålet: Skriv på morsmålet, bygg flerspråklige versjoner sømløst
|
|
36
|
+
|
|
37
|
+
Livet er kort, jeg gidder ikke oversette. Når man bruker morsmålet, kan man utnytte sin tankedybde best. Men samtidig er det nødvendig å forbli tilkoblet verden, jeg vil ikke gi slipp på flerspråklig kommunikasjon. Derfor ønsker jeg et verktøy som lar meg skrive på morsmålet, samtidig som det lar flere se innholdet mitt. Nåværende i18n krever at man oversetter selv, og i tillegg må man vedlikeholde innholdsopdateringer, det er for mye arbeid. Jeg velger å bruke LLM til å hjelpe meg med oversettelse, det sparer mye tid og kan fullføre oversettelse til flere språk med ett klikk.
|
|
38
|
+
|
|
39
|
+
## Hurtigstart
|
|
40
|
+
|
|
41
|
+
Forutsetninger:
|
|
42
|
+
|
|
43
|
+
- [Node.js](https://nodejs.org/) er installert (anbefalt versjon 18 eller høyere, må ha npx-kommandoen)
|
|
44
|
+
- [OpenAI API-nøkkel](https://platform.openai.com/account/api-keys) er anskaffet, eller en OPENAI-kompatibel API-nøkkel
|
|
45
|
+
- Git er installert (brukes til å liste Markdown-filer fra Git, ignorerer filer filtrert av .gitignore-regler)
|
|
46
|
+
|
|
47
|
+
Først, arbeid i en mappe som allerede er administrert av Git:
|
|
48
|
+
|
|
49
|
+
Konfigurer miljøvariabler
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
export OPENAI_API_KEY="sk-xxxxxx" # Påkrevd: Erstatt med din OpenAI API-nøkkel
|
|
53
|
+
export OPENAI_BASE_URL="https://api.openai.com/v1" # Valgfritt, bruker offisiell OpenAI API som standard
|
|
54
|
+
export OPENAI_MODEL="gpt-3.5-turbo" # Valgfritt, bruker gpt-3.5-turbo-modellen som standard
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Bygg nettstedet, støtter flerspråklig oversettelse. Bruker gjeldende katalog som kildekatalog, skriver ut til `.zen/dist`-katalogen.
|
|
58
|
+
|
|
59
|
+
- Du kan spesifisere språkversjoner som skal genereres ved å bruke `--lang`-parameteren flere ganger (f.eks. `--lang zh-Hans --lang en-US`).
|
|
60
|
+
- Du kan spesifisere nettstedets basis-URL-prefiks med `--base-url`-parameteren (f.eks. depotnavn på GitHub Pages).
|
|
61
|
+
- Kilde språk trenger ikke konfigureres, ZEN oppdager det automatisk.
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npx zengen@latest build --lang zh-Hans --lang en-US
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
**Se flere parametere eller hjelp**:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx zengen@latest
|
|
71
|
+
```
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
---
|
|
2
|
+
'title': 'Dokument testowy diagramów Mermaid'
|
|
3
|
+
'summary': 'Ten dokument jest plikiem testowym służącym do weryfikacji funkcji renderowania diagramów Mermaid w ZEN. Zawiera przykłady różnych typów diagramów Mermaid, takich jak schematy blokowe, diagramy sekwencji, diagramy Gantta, diagramy klas, diagramy stanów i wykresy kołowe, a także test błędnej składni w celu sprawdzenia wyświetlania komunikatów o błędach. Dokument ma na celu zademonstrowanie poprawnego działania integracji Mermaid w ZEN.'
|
|
4
|
+
'tags':
|
|
5
|
+
- 'Mermaid'
|
|
6
|
+
- 'Test diagramów'
|
|
7
|
+
- 'ZEN'
|
|
8
|
+
- 'Schemat blokowy'
|
|
9
|
+
- 'Diagram sekwencji'
|
|
10
|
+
- 'Diagram Gantta'
|
|
11
|
+
- 'Diagram klas'
|
|
12
|
+
- 'Diagram stanów'
|
|
13
|
+
'inferred_date': '2024-01-01'
|
|
14
|
+
'inferred_lang': 'pl-PL'
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# Test diagramów Mermaid
|
|
18
|
+
|
|
19
|
+
To jest plik testowy służący do weryfikacji funkcji renderowania diagramów Mermaid w ZEN.
|
|
20
|
+
|
|
21
|
+
## Przykład schematu blokowego
|
|
22
|
+
|
|
23
|
+
```mermaid
|
|
24
|
+
graph TD
|
|
25
|
+
A[Start] --> B{Czy kontynuować?}
|
|
26
|
+
B -->|Tak| C[Wykonaj operację]
|
|
27
|
+
B -->|Nie| D[Koniec]
|
|
28
|
+
C --> E[Sprawdź wynik]
|
|
29
|
+
E --> F{Czy sukces?}
|
|
30
|
+
F -->|Tak| G[Zakończono]
|
|
31
|
+
F -->|Nie| H[Ponów próbę]
|
|
32
|
+
H --> C
|
|
33
|
+
G --> D
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Przykład diagramu sekwencji
|
|
37
|
+
|
|
38
|
+
```mermaid
|
|
39
|
+
sequenceDiagram
|
|
40
|
+
participant Użytkownik
|
|
41
|
+
participant System
|
|
42
|
+
participant BazaDanych
|
|
43
|
+
|
|
44
|
+
Użytkownik->>System: Wyślij żądanie
|
|
45
|
+
System->>BazaDanych: Zapytaj o dane
|
|
46
|
+
BazaDanych-->>System: Zwróć wynik
|
|
47
|
+
System-->>Użytkownik: Wyświetl wynik
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Przykład diagramu Gantta
|
|
51
|
+
|
|
52
|
+
```mermaid
|
|
53
|
+
gantt
|
|
54
|
+
title Harmonogram projektu
|
|
55
|
+
dateFormat YYYY-MM-DD
|
|
56
|
+
section Projektowanie
|
|
57
|
+
Analiza wymagań :done, des1, 2024-01-01, 7d
|
|
58
|
+
Projekt prototypu :active, des2, 2024-01-08, 5d
|
|
59
|
+
Projekt szczegółowy : des3, after des2, 5d
|
|
60
|
+
section Rozwój
|
|
61
|
+
Rozwój frontendu : dev1, after des3, 10d
|
|
62
|
+
Rozwój backendu : dev2, after des3, 15d
|
|
63
|
+
section Testy
|
|
64
|
+
Testy jednostkowe : test1, after dev1, 5d
|
|
65
|
+
Testy integracyjne : test2, after dev2, 5d
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Przykład diagramu klas
|
|
69
|
+
|
|
70
|
+
```mermaid
|
|
71
|
+
classDiagram
|
|
72
|
+
class Zwierzę {
|
|
73
|
+
+String nazwa
|
|
74
|
+
+int wiek
|
|
75
|
+
+void jedz()
|
|
76
|
+
+void śpij()
|
|
77
|
+
}
|
|
78
|
+
class Pies {
|
|
79
|
+
+void szczekaj()
|
|
80
|
+
}
|
|
81
|
+
class Kot {
|
|
82
|
+
+void miaucz()
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
Zwierzę <|-- Pies
|
|
86
|
+
Zwierzę <|-- Kot
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Przykład diagramu stanów
|
|
90
|
+
|
|
91
|
+
```mermaid
|
|
92
|
+
stateDiagram-v2
|
|
93
|
+
[*] --> Bezczynny
|
|
94
|
+
Bezczynny --> Przetwarzanie : Rozpocznij przetwarzanie
|
|
95
|
+
Przetwarzanie --> Sukces : Przetwarzanie zakończone sukcesem
|
|
96
|
+
Przetwarzanie --> Błąd : Przetwarzanie zakończone niepowodzeniem
|
|
97
|
+
Sukces --> [*]
|
|
98
|
+
Błąd --> [*]
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
## Przykład wykresu kołowego
|
|
102
|
+
|
|
103
|
+
```mermaid
|
|
104
|
+
pie title Udział w rynku przeglądarek
|
|
105
|
+
"Chrome" : 65.2
|
|
106
|
+
"Firefox" : 15.3
|
|
107
|
+
"Safari" : 12.5
|
|
108
|
+
"Edge" : 5.2
|
|
109
|
+
"Inne" : 1.8
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## Test błędnej składni (powinien wyświetlić komunikat o błędzie)
|
|
113
|
+
|
|
114
|
+
```mermaid
|
|
115
|
+
graph TD
|
|
116
|
+
A --> B
|
|
117
|
+
// Brak definicji strzałki
|
|
118
|
+
C --> D
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
Ten plik testowy zawiera różne typy diagramów Mermaid, służące do weryfikacji, czy integracja Mermaid w ZEN działa poprawnie.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
'title': 'ZEN - Minimalistyczny generator statycznych stron Markdown + AI'
|
|
3
|
+
'summary': 'ZEN to generator statycznych stron zintegrowany z AI, skupiający się na uproszczeniu procesu pisania dokumentów i budowania. Umożliwia użytkownikom tworzenie statycznych stron HTML w folderze zarządzanym przez git przy użyciu Markdown, bez skomplikowanej konfiguracji – wszystkie ustawienia są ukryte w katalogu .zen. Kluczowe funkcje obejmują inteligentną nawigację kategorii (generowanie mapy strony poprzez analizę treści przez AI), automatyczne tłumaczenie przyrostowe (obsługa wersji wielojęzycznych, użytkownicy mogą pisać w języku ojczystym, a AI zajmuje się tłumaczeniem) oraz doświadczenie pisania z minimalnymi zakłóceniami. Narzędzie wymaga Node.js, klucza API OpenAI i Gita, umożliwia szybkie budowanie przez wiersz poleceń i obsługuje parametry językowe, takie jak zh-Hans i en-US.'
|
|
4
|
+
'tags':
|
|
5
|
+
- 'generator statycznych stron'
|
|
6
|
+
- 'Markdown'
|
|
7
|
+
- 'AI'
|
|
8
|
+
- 'tłumaczenie wielojęzyczne'
|
|
9
|
+
- 'minimalizm'
|
|
10
|
+
- 'narzędzie do dokumentacji'
|
|
11
|
+
- 'ZEN'
|
|
12
|
+
'inferred_lang': 'zh-Hans'
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Minimalistyczny generator statycznych stron Markdown + AI
|
|
16
|
+
|
|
17
|
+
[> Demo strony internetowej](https://zen.zccz14.com/)
|
|
18
|
+
|
|
19
|
+
## Podstawowe funkcje
|
|
20
|
+
|
|
21
|
+
1. 📃 **Generowanie statycznych stron**: Przekształca dowolny folder git zawierający pliki Markdown w statyczną stronę HTML.
|
|
22
|
+
2. 🧭 **Inteligentna nawigacja kategorii**: Wykorzystuje AI do analizy treści, generując mapę strony i nawigację, niezależnie od lokalizacji plików źródłowych.
|
|
23
|
+
3. 🌍 **Automatyczne tłumaczenie przyrostowe**: Wykorzystuje AI do tłumaczenia przyrostowego, pozwalając użytkownikom pisać w Markdown w języku ojczystym, jednocześnie udostępniając treść w wielu językach.
|
|
24
|
+
|
|
25
|
+
Po co kolejny generator statycznych stron Markdown? Ponownie przemyślałem, jak narzędzia do dokumentacji w erze AI mogą lepiej służyć autorom:
|
|
26
|
+
|
|
27
|
+
- **Powrót do treści: Minimalne zakłócenia, skupienie na pisaniu**
|
|
28
|
+
|
|
29
|
+
Niech dokumenty wrócą do swojej istoty, a pisanie do spokoju.
|
|
30
|
+
|
|
31
|
+
Po pierwsze, nie chcę być bibliotekarzem. Czasami chcę coś napisać, ale może jeszcze nie wymyśliłem tytułu ani nie ukształtowałem struktury. Chcę, aby LLM automatycznie generował dla mnie tytuły, tworzył streszczenia, kategoryzował, organizował nawigację i inne zadania porządkowe.
|
|
32
|
+
|
|
33
|
+
Po drugie, moje biurko musi być czyste. Nie chcę skomplikowanych narzędzi do budowania, męczącej konfiguracji dokumentacji ani złożonych struktur. Za każdym razem, gdy widzę pliki konfiguracyjne i struktury projektów takich narzędzi jak Docusaurus, VuePress czy Astro, boli mnie głowa. Teraz ZEN ukrywa całą konfigurację w katalogu `.zen`, zamiatając ją w kąt. Użytkownik musi skupić się tylko na treści, resztą zajmie się ZEN. Wszystkie inne katalogi to Twoja przestrzeń do pisania – możesz dowolnie organizować swoje pliki Markdown.
|
|
34
|
+
|
|
35
|
+
- **Powrót do języka ojczystego: Pisz w języku ojczystym, płynnie twórz wersje wielojęzyczne**
|
|
36
|
+
|
|
37
|
+
Życie jest krótkie, nie mam ochoty na tłumaczenie. Człowiek myśli najgłębiej, gdy używa języka ojczystego. Jednocześnie konieczne jest utrzymanie połączenia ze światem – nie chcę rezygnować z komunikacji wielojęzycznej. Dlatego chcę narzędzia, które pozwoli mi pisać w języku ojczystym, a jednocześnie udostępnić moje treści szerszemu gronu. Obecne rozwiązania i18n wymagają nie tylko własnego tłumaczenia, ale także samodzielnego utrzymywania aktualności treści – to zbyt uciążliwe. Wybieram wykorzystanie LLM do tłumaczenia, co oszczędza mi mnóstwo czasu i pozwala na jednym kliknięciu uzyskać tłumaczenia na wiele języków.
|
|
38
|
+
|
|
39
|
+
## Szybki start
|
|
40
|
+
|
|
41
|
+
Wymagania wstępne:
|
|
42
|
+
|
|
43
|
+
- Zainstalowany [Node.js](https://nodejs.org/) (zalecana wersja 18 lub nowsza, wymagane polecenie `npx`)
|
|
44
|
+
- Uzyskany [klucz API OpenAI](https://platform.openai.com/account/api-keys) lub kompatybilny klucz API OPENAI
|
|
45
|
+
- Zainstalowany Git (do listowania plików Markdown z gita, z pominięciem plików filtrowanych przez reguły `.gitignore`)
|
|
46
|
+
|
|
47
|
+
Najpierw pracuj w folderze już zarządzanym przez gita:
|
|
48
|
+
|
|
49
|
+
Skonfiguruj zmienne środowiskowe
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
export OPENAI_API_KEY="sk-xxxxxx" # Wymagane: zastąp swoim kluczem API OpenAI
|
|
53
|
+
export OPENAI_BASE_URL="https://api.openai.com/v1" # Opcjonalne, domyślnie używa oficjalnego API OpenAI
|
|
54
|
+
export OPENAI_MODEL="gpt-3.5-turbo" # Opcjonalne, domyślnie używa modelu gpt-3.5-turbo
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Zbuduj stronę z obsługą tłumaczenia wielojęzycznego. Użyj bieżącego katalogu jako źródła, wynik zostanie zapisany w katalogu `.zen/dist`.
|
|
58
|
+
|
|
59
|
+
- Możesz wielokrotnie użyć parametru `--lang`, aby określić wersje językowe do wygenerowania (np. `--lang zh-Hans --lang en-US`).
|
|
60
|
+
- Nie trzeba konfigurować języka źródłowego, ZEN wykryje go automatycznie.
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
npx zengen@latest build --lang zh-Hans --lang en-US
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
**Zobacz więcej parametrów lub pomoc**:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
npx zengen@latest
|
|
70
|
+
```
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
'title': 'ZEN - Minimalistyczny generator statycznych stron Markdown + AI'
|
|
3
|
+
'summary': 'ZEN to generator statycznych stron z funkcjami AI, zaprojektowany specjalnie dla dokumentów Markdown. Umożliwia użytkownikom przekształcenie folderu Git zawierającego pliki Markdown w statyczną stronę HTML bez skomplikowanej konfiguracji — wszystkie ustawienia są ukryte w katalogu .zen. Kluczowe funkcje obejmują inteligentną nawigację kategorii (używającą AI do analizy treści i generowania mapy strony), automatyczne tłumaczenie przyrostowe (obsługa wersji wielojęzycznych, użytkownicy mogą pisać w języku ojczystym, a AI zajmuje się tłumaczeniem) oraz doświadczenie pisania z minimalnymi zakłóceniami. Przewodnik szybkiego startu wymaga zainstalowania Node.js, uzyskania klucza API OpenAI i Gita, budowania strony za pomocą wiersza poleceń oraz obsługi określania języka i podstawowego adresu URL.'
|
|
4
|
+
'tags':
|
|
5
|
+
- 'Generator statycznych stron'
|
|
6
|
+
- 'Markdown'
|
|
7
|
+
- 'AI'
|
|
8
|
+
- 'Tłumaczenie wielojęzyczne'
|
|
9
|
+
- 'Minimalizm'
|
|
10
|
+
- 'Narzędzie do dokumentacji'
|
|
11
|
+
- 'Git'
|
|
12
|
+
'inferred_lang': 'zh-Hans'
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Minimalistyczny generator statycznych stron Markdown + AI
|
|
16
|
+
|
|
17
|
+
[> Demo strony internetowej](https://zen.zccz14.com/)
|
|
18
|
+
|
|
19
|
+
## Podstawowe funkcje
|
|
20
|
+
|
|
21
|
+
1. 📃 **Generowanie statycznych stron**: Przekształć dowolny folder git zawierający pliki Markdown w statyczną stronę HTML.
|
|
22
|
+
2. 🧭 **Inteligentna nawigacja kategorii**: Użyj AI do analizy treści, generowania mapy strony i nawigacji, bez wrażliwości na lokalizację plików źródłowych.
|
|
23
|
+
3. 🌍 **Automatyczne tłumaczenie przyrostowe**: Użyj AI do tłumaczenia przyrostowego, pozwalając użytkownikom pisać w Markdown w języku ojczystym, jednocześnie umożliwiając im tworzenie treści wielojęzycznych.
|
|
24
|
+
|
|
25
|
+
Dlaczego stworzyłem kolejny generator statycznych stron dla Markdown? Ponownie przemyślałem, jak narzędzia do dokumentacji mogą lepiej służyć pisarzom w erze AI:
|
|
26
|
+
|
|
27
|
+
- **Powrót do treści: Minimalizacja zakłóceń, skupienie na pisaniu**
|
|
28
|
+
|
|
29
|
+
Niech dokumenty wrócą do swojej istoty, a pisanie do spokoju.
|
|
30
|
+
|
|
31
|
+
Po pierwsze, nie chcę być bibliotekarzem. Czasami chcę coś napisać, ale może jeszcze nie wymyśliłem tytułu ani nie ukształtowałem struktury. Chcę, aby LLM automatycznie generował dla mnie tytuły, tworzył streszczenia, kategoryzował, organizował nawigację i inne prace porządkowe.
|
|
32
|
+
|
|
33
|
+
Po drugie, mój gabinet musi być posprzątany. Nie chcę skomplikowanych narzędzi do budowania, męczącej konfiguracji dokumentacji ani złożonych struktur. Za każdym razem, gdy widzę pliki konfiguracyjne i struktury projektów takich narzędzi jak Docusaurus, VuePress czy Astro, boli mnie głowa. Teraz ZEN ukrywa całą konfigurację w katalogu `.zen`, zamiatając ją w kąt. Użytkownik musi skupić się tylko na treści, resztą zajmie się ZEN. Wszystkie inne katalogi to Twoja przestrzeń do pisania — możesz dowolnie organizować swoje pliki Markdown.
|
|
34
|
+
|
|
35
|
+
- **Powrót do języka ojczystego: Pisz w języku ojczystym, płynnie twórz wersje wielojęzyczne**
|
|
36
|
+
|
|
37
|
+
Życie jest krótkie, nie mam ochoty na tłumaczenie. Człowiek myśli najgłębiej, gdy używa języka ojczystego. Jednocześnie konieczne jest utrzymanie kontaktu ze światem — nie chcę rezygnować z komunikacji wielojęzykowej. Dlatego chcę narzędzia, które pozwoli mi pisać w języku ojczystym, a jednocześnie dotrzeć z treścią do większej liczby osób. Obecne rozwiązania i18n wymagają samodzielnego tłumaczenia i utrzymywania aktualności treści, co jest zbyt uciążliwe. Wybieram użycie LLM do pomocy w tłumaczeniu, oszczędzając mnóstwo czasu i umożliwiając tłumaczenie na wiele języków jednym kliknięciem.
|
|
38
|
+
|
|
39
|
+
## Szybki start
|
|
40
|
+
|
|
41
|
+
Wymagania wstępne:
|
|
42
|
+
|
|
43
|
+
- Zainstalowany [Node.js](https://nodejs.org/) (zalecana wersja 18 lub nowsza, wymagane polecenie `npx`)
|
|
44
|
+
- Uzyskany [klucz API OpenAI](https://platform.openai.com/account/api-keys) lub kompatybilny klucz API OPENAI
|
|
45
|
+
- Zainstalowany Git (do listowania plików Markdown z Gita, z pominięciem plików filtrowanych przez reguły `.gitignore`)
|
|
46
|
+
|
|
47
|
+
Najpierw pracuj w folderze zarządzanym przez gita:
|
|
48
|
+
|
|
49
|
+
Skonfiguruj zmienne środowiskowe
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
export OPENAI_API_KEY="sk-xxxxxx" # Wymagane: zastąp swoim kluczem API OpenAI
|
|
53
|
+
export OPENAI_BASE_URL="https://api.openai.com/v1" # Opcjonalne, domyślnie używa oficjalnego API OpenAI
|
|
54
|
+
export OPENAI_MODEL="gpt-3.5-turbo" # Opcjonalne, domyślnie używa modelu gpt-3.5-turbo
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Zbuduj stronę, obsługującą tłumaczenie wielojęzyczne. Użyj bieżącego katalogu jako katalogu źródłowego, wynik zostanie zapisany w katalogu `.zen/dist`.
|
|
58
|
+
|
|
59
|
+
- Możesz wielokrotnie użyć parametru `--lang`, aby określić wersje językowe do wygenerowania (np. `--lang zh-Hans --lang en-US`).
|
|
60
|
+
- Możesz użyć parametru `--base-url`, aby określić podstawowy prefiks URL strony (np. nazwa repozytorium na GitHub Pages).
|
|
61
|
+
- Nie ma potrzeby konfigurowania języka źródłowego, ZEN wykryje go automatycznie.
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npx zengen@latest build --lang zh-Hans --lang en-US
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
**Zobacz więcej parametrów lub uzyskaj pomoc**:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx zengen@latest
|
|
71
|
+
```
|