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 - Minimalist Markdown + AI Statik Site Oluşturucu
|
|
3
|
+
summary: ZEN, akıllı sınıflandırma navigasyonu ve otomatik artımlı çeviri desteği sunan, AI ile entegre bir statik site oluşturucudur. Kullanıcıların ana dillerinde yazmaya odaklanmasını sağlar, yapılandırma ve derleme sürecini basitleştirir.
|
|
4
|
+
tags:
|
|
5
|
+
- Statik Site Oluşturucu
|
|
6
|
+
- Markdown
|
|
7
|
+
- AI
|
|
8
|
+
- Çok Dilli Çeviri
|
|
9
|
+
- Minimalizm
|
|
10
|
+
- Dokümantasyon Aracı
|
|
11
|
+
- Node.js
|
|
12
|
+
inferred_lang: tr-TR
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Minimalist Markdown + AI Statik Site Oluşturucu
|
|
16
|
+
|
|
17
|
+
[> Website Demo](https://zccz14.github.io/ZEN/)
|
|
18
|
+
|
|
19
|
+
## Temel Özellikler
|
|
20
|
+
|
|
21
|
+
1. 📃 **Statik Site Oluşturma**: Markdown içeren herhangi bir git klasörünü statik bir HTML sitesine dönüştürür.
|
|
22
|
+
2. 🧭 **Akıllı Sınıflandırma Navigasyonu**: AI kullanarak içerik analizi yapar, site haritası ve navigasyon oluşturur. Kaynak dosyaların konumu önemli değildir.
|
|
23
|
+
3. 🌍 **Otomatik Artımlı Çeviri**: AI kullanarak artımlı çeviri yapar. Kullanıcılar Markdown'ı ana dillerinde yazabilir, ancak site çok dilli olabilir.
|
|
24
|
+
|
|
25
|
+
Neden bir Markdown statik site oluşturucusu daha? AI çağında, dokümantasyon araçlarının yazarlara nasıl daha iyi hizmet edebileceğini yeniden düşündüm:
|
|
26
|
+
|
|
27
|
+
- İçeriğe Dönüş: Müdahaleyi en aza indirin, yazmaya odaklanın
|
|
28
|
+
|
|
29
|
+
Dokümanları özüne döndürün, yazmayı huzurlu bir deneyim haline getirin.
|
|
30
|
+
|
|
31
|
+
Birincisi, kütüphaneci olmak istemiyorum. Bazen bir şeyler yazmak isterim ama henüz başlığını düşünmemiş, belirli bir organizasyon oluşturmamış olabilirim. LLM'nin başlık oluşturma, özet çıkarma, sınıflandırma, navigasyon gibi düzenleme işlerini otomatik yapmasını umuyorum.
|
|
32
|
+
|
|
33
|
+
İkincisi, çalışma odam temiz olmalı. Karmaşık yapılandırmalı derleme araçları, karmaşık doküman ayarlarıyla uğraşmak, karmaşık yapıları sevmiyorum. Docusaurus, VuePress, Astro gibi araçların yapılandırma dosyalarını ve proje yapılarını her gördüğümde başım ağrıyor. Şimdi, ZEN tüm yapılandırmaları `.zen` dizinine gizlemeyi, köşeye süpürmeyi seçiyor. Kullanıcı sadece içerik yazmaya odaklanır, gerisini ZEN halleder. Diğer tüm dizinler sizin yazma alanınızdır, Markdown dosyalarınızı istediğiniz gibi düzenleyebilirsiniz.
|
|
34
|
+
|
|
35
|
+
- Ana Dile Dönüş: Ana dilinizde yazın, çok dilli sürümleri sorunsuz oluşturun
|
|
36
|
+
|
|
37
|
+
Hayat kısa, çeviri yapmakla uğraşmak istemiyorum. İnsanlar ana dillerini kullanırken düşüncelerinin derinliğini en iyi şekilde ortaya koyabilir. Ancak aynı zamanda dünyayla bağlantıda kalmak da gereklidir, çok dilli iletişimi bırakmak istemiyorum. Bu yüzden, ana dilimde yazmama izin veren, aynı zamanda içeriğimi daha fazla kişiye ulaştırabilen bir araç istiyorum. Mevcut i18n çözümleri sadece kendi çevirinizi yapmanızı gerektirmekle kalmaz, aynı zamanda içerik güncellemelerini de sizin yönetmenizi gerektirir, bu çok zahmetli. Çevirileri yapmak için LLM'yi kullanmayı seçiyorum, bu bana çok zaman kazandırıyor ve tek tıkla çoklu dil çevirisi yapılabiliyor.
|
|
38
|
+
|
|
39
|
+
## Hızlı Başlangıç
|
|
40
|
+
|
|
41
|
+
Ön Koşullar:
|
|
42
|
+
|
|
43
|
+
- [Node.js](https://nodejs.org/) kurulu olmalı (18 veya üzeri sürüm önerilir, npx komutu gereklidir)
|
|
44
|
+
- [OpenAI API Anahtarı](https://platform.openai.com/account/api-keys) veya OPENAI uyumlu bir API Anahtarı edinilmiş olmalı
|
|
45
|
+
- Git kurulu olmalı (Markdown dosyalarını Git'ten listelemek ve .gitignore kurallarıyla filtrelenen dosyaları yok saymak için)
|
|
46
|
+
|
|
47
|
+
İlk olarak, git ile yönetilen bir klasörde çalışın:
|
|
48
|
+
|
|
49
|
+
Ortam değişkenlerini yapılandırın
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
export OPENAI_API_KEY="sk-xxxxxx" # Zorunlu: Lütfen kendi OpenAI API Anahtarınızla değiştirin
|
|
53
|
+
export OPENAI_BASE_URL="https://api.openai.com/v1" # Opsiyonel, varsayılan olarak OpenAI resmi API'si kullanılır
|
|
54
|
+
export OPENAI_MODEL="gpt-3.5-turbo" # Opsiyonel, varsayılan olarak gpt-3.5-turbo modeli kullanılır
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Siteyi oluşturun, çok dilli çeviriyi destekler. Mevcut dizini kaynak dizin olarak kullanır, çıktıyı `.zen/dist` dizinine yazar.
|
|
58
|
+
|
|
59
|
+
- Oluşturulacak dil sürümlerini belirtmek için `--lang` parametresi birden fazla kez kullanılabilir (örneğin `--lang tr-TR --lang en-US`).
|
|
60
|
+
- Sitenin temel URL önekini belirtmek için `--base-url` parametresi kullanılabilir (örneğin GitHub Pages'teki depo adı).
|
|
61
|
+
- Kaynak dili yapılandırmaya gerek yoktur, ZEN otomatik olarak algılar.
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npx zengen@latest build --lang tr-TR --lang en-US
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
**Daha fazla parametre veya yardım için**:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx zengen@latest
|
|
71
|
+
```
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ZEN - Мінімалістичний Markdown + AI генератор статичних сайтів
|
|
3
|
+
summary: ZEN — це генератор статичних сайтів з інтеграцією AI, що підтримує розумну категорізацію, навігацію та автоматичний інкрементальний переклад, дозволяючи користувачам зосередитись на написанні рідною мовою та спрощуючи процес налаштування та збірки.
|
|
4
|
+
tags:
|
|
5
|
+
- Генератор статичних сайтів
|
|
6
|
+
- Markdown
|
|
7
|
+
- AI
|
|
8
|
+
- Багатомовний переклад
|
|
9
|
+
- Мінімалізм
|
|
10
|
+
- Інструмент для документації
|
|
11
|
+
- Node.js
|
|
12
|
+
inferred_lang: uk-UA
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Мінімалістичний Markdown + AI генератор статичних сайтів
|
|
16
|
+
|
|
17
|
+
[> Демо сайту](https://zccz14.github.io/ZEN/)
|
|
18
|
+
|
|
19
|
+
## Основні функції
|
|
20
|
+
|
|
21
|
+
1. 📃 **Генерація статичного сайту**: Перетворює будь-яку папку з файлами Markdown, яка керується git, на статичний HTML-сайт.
|
|
22
|
+
2. 🧭 **Розумна категорізація та навігація**: Використовує AI для аналізу вмісту, генерації карти сайту та навігації. Розташування вихідних файлів не має значення.
|
|
23
|
+
3. 🌍 **Автоматичний інкрементальний переклад**: Використовує AI для інкрементального перекладу, дозволяючи користувачам писати Markdown рідною мовою, але отримувати багатомовний вміст.
|
|
24
|
+
|
|
25
|
+
Чому ще один генератор статичних сайтів для Markdown? Я переосмислив, як інструменти для документації в епоху AI можуть краще служити письменникам:
|
|
26
|
+
|
|
27
|
+
- Повернення до змісту: мінімізація відволікань, фокус на написанні
|
|
28
|
+
|
|
29
|
+
Повернути документацію до її сутності, а написанню — спокій.
|
|
30
|
+
|
|
31
|
+
По-перше, я не хочу бути бібліотекарем. Іноді я хочу щось записати, але ще не визначився з заголовком або структурою. Я хочу, щоб LLM автоматично генерував заголовки, робив резюме, категорії, навігацію та іншу організаційну роботу.
|
|
32
|
+
|
|
33
|
+
По-друге, мій робочий простір має бути чистим. Я не хочу складно налаштовувати інструменти збірки, возитися зі складними конфігураціями документації чи складною структурою. Кожного разу, коли я бачу конфігураційні файли та структуру проектів таких інструментів, як Docusaurus, VuePress, Astro, у мене болить голова. Тепер ZEN вирішив сховати всю конфігурацію в каталог `.zen`, засунути її в кут, щоб користувач міг зосередитись лише на написанні контенту, а все інше залишити ZEN. Всі інші каталоги — це ваш робочий простір, ви можете організовувати свої файли Markdown як завгодно.
|
|
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 (для отримання списку файлів Markdown з 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 uk-UA --lang en-US`).
|
|
60
|
+
- Базовий URL-префікс сайту можна вказати за допомогою параметра `--base-url` (наприклад, ім'я репозиторію на GitHub Pages).
|
|
61
|
+
- Вихідну мову налаштовувати не потрібно, ZEN визначить її автоматично.
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npx zengen@latest build --lang uk-UA --lang en-US
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
**Переглянути більше параметрів або отримати довідку**:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx zengen@latest
|
|
71
|
+
```
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ZEN - Trình tạo trang tĩnh Markdown + AI theo chủ nghĩa tối giản
|
|
3
|
+
summary: ZEN là một trình tạo trang tĩnh tích hợp AI, hỗ trợ điều hướng phân loại thông minh và dịch thuật tự động tăng dần, cho phép người dùng tập trung viết bằng ngôn ngữ mẹ đẻ, đơn giản hóa quá trình cấu hình và xây dựng.
|
|
4
|
+
tags:
|
|
5
|
+
- Trình tạo trang tĩnh
|
|
6
|
+
- Markdown
|
|
7
|
+
- AI
|
|
8
|
+
- Dịch thuật đa ngôn ngữ
|
|
9
|
+
- Chủ nghĩa tối giản
|
|
10
|
+
- Công cụ tài liệu
|
|
11
|
+
- Node.js
|
|
12
|
+
inferred_lang: vi-VN
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Trình tạo trang tĩnh Markdown + AI theo chủ nghĩa tối giản
|
|
16
|
+
|
|
17
|
+
[> Website Demo](https://zccz14.github.io/ZEN/)
|
|
18
|
+
|
|
19
|
+
## Chức năng cơ bản
|
|
20
|
+
|
|
21
|
+
1. 📃 **Tạo trang tĩnh**: Biến bất kỳ thư mục git chứa Markdown nào thành một trang HTML tĩnh.
|
|
22
|
+
2. 🧭 **Điều hướng phân loại thông minh**: Sử dụng AI để phân tích nội dung, tạo sơ đồ trang và điều hướng, không phụ thuộc vào vị trí của tệp nguồn.
|
|
23
|
+
3. 🌍 **Dịch thuật tự động tăng dần**: Sử dụng AI để dịch tăng dần, cho phép người dùng viết Markdown bằng ngôn ngữ mẹ đẻ, nhưng có thể hỗ trợ đa ngôn ngữ.
|
|
24
|
+
|
|
25
|
+
Tại sao lại tạo ra một trình tạo trang tĩnh Markdown nữa? Tôi đã suy nghĩ lại về cách các công cụ tài liệu trong thời đại AI có thể phục vụ người viết tốt hơn:
|
|
26
|
+
|
|
27
|
+
- Trở về với nội dung: Giảm thiểu sự phiền nhiễu, tập trung vào việc viết
|
|
28
|
+
|
|
29
|
+
Đưa tài liệu trở lại bản chất, đưa việc viết trở về sự tĩnh lặng.
|
|
30
|
+
|
|
31
|
+
Thứ nhất, tôi không muốn làm thủ thư. Đôi khi tôi muốn viết một số nội dung, nhưng có thể tôi chưa nghĩ ra tiêu đề cho nó, chưa hình thành cấu trúc tổ chức cụ thể. Tôi hy vọng LLM sẽ tự động giúp tôi tạo tiêu đề, tóm tắt, phân loại, điều hướng và các công việc sắp xếp khác.
|
|
32
|
+
|
|
33
|
+
Thứ hai, thư phòng của tôi phải được dọn dẹp sạch sẽ. Tôi không muốn các công cụ xây dựng cấu hình phức tạp, vặn vẹo cấu hình tài liệu phức tạp, không thích cấu trúc phức tạp. Mỗi lần nhìn thấy các tệp cấu hình và cấu trúc dự án của các công cụ như Docusaurus, VuePress, Astro, tôi lại đau đầu. Bây giờ, ZEN chọn cách ẩn tất cả cấu hình vào thư mục .zen, quét vào góc, người dùng chỉ cần tập trung vào việc viết nội dung, phần còn lại để ZEN xử lý. Các thư mục khác đều là không gian viết của bạn, bạn có thể tự do tổ chức các tệp Markdown của mình.
|
|
34
|
+
|
|
35
|
+
- Trở về với tiếng mẹ đẻ: Viết bằng tiếng mẹ đẻ, xây dựng phiên bản đa ngôn ngữ mượt mà
|
|
36
|
+
|
|
37
|
+
Cuộc đời ngắn ngủi, tôi lười dịch. Khi sử dụng ngôn ngữ mẹ đẻ, con người mới có thể phát huy tối đa chiều sâu tư duy của mình. Nhưng đồng thời việc giữ kết nối với thế giới là cần thiết, tôi không muốn từ bỏ giao tiếp đa ngôn ngữ. Vì vậy, tôi hy vọng có một công cụ cho phép tôi viết bằng ngôn ngữ mẹ đẻ, đồng thời lại có thể để nhiều người hơn xem được nội dung của tôi. Hiện tại, i18n không chỉ yêu cầu tự dịch mà còn phải tự duy trì cập nhật nội dung, quá phiền phức. Tôi chọn sử dụng LLM để giúp tôi dịch, tiết kiệm rất nhiều thời gian và có thể hoàn thành dịch thuật đa quốc gia chỉ với một cú nhấp chuột.
|
|
38
|
+
|
|
39
|
+
## Bắt đầu nhanh
|
|
40
|
+
|
|
41
|
+
Điều kiện tiên quyết:
|
|
42
|
+
|
|
43
|
+
- Đã cài đặt [Node.js](https://nodejs.org/) (khuyến nghị phiên bản 18 trở lên, cần có lệnh npx)
|
|
44
|
+
- Đã lấy [OpenAI API Key](https://platform.openai.com/account/api-keys), hoặc API Key tương thích với OPENAI
|
|
45
|
+
- Đã cài đặt Git (dùng để liệt kê các tệp Markdown từ Git, bỏ qua các tệp bị lọc bởi quy tắc .gitignore)
|
|
46
|
+
|
|
47
|
+
Đầu tiên, làm việc trong một thư mục đã được quản lý bởi git:
|
|
48
|
+
|
|
49
|
+
Cấu hình biến môi trường
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
export OPENAI_API_KEY="sk-xxxxxx" # Bắt buộc: Vui lòng thay thế bằng OpenAI API Key của bạn
|
|
53
|
+
export OPENAI_BASE_URL="https://api.openai.com/v1" # Tùy chọn, mặc định sử dụng API chính thức của OpenAI
|
|
54
|
+
export OPENAI_MODEL="gpt-3.5-turbo" # Tùy chọn, mặc định sử dụng mô hình gpt-3.5-turbo
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Xây dựng trang web, hỗ trợ dịch thuật đa ngôn ngữ. Sử dụng thư mục hiện tại làm thư mục nguồn, đầu ra đến thư mục `.zen/dist`.
|
|
58
|
+
|
|
59
|
+
- Có thể chỉ định các phiên bản ngôn ngữ cần tạo bằng cách sử dụng nhiều lần tham số `--lang` (ví dụ: `--lang zh-Hans --lang en-US`).
|
|
60
|
+
- Có thể chỉ định tiền tố URL cơ sở của trang web bằng tham số `--base-url` (ví dụ: tên kho lưu trữ trên GitHub Pages).
|
|
61
|
+
- Không cần cấu hình ngôn ngữ nguồn, ZEN sẽ tự động phát hiện.
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npx zengen@latest build --lang zh-Hans --lang en-US
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
**Xem thêm tham số hoặc trợ giúp**:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx zengen@latest
|
|
71
|
+
```
|
|
@@ -0,0 +1,73 @@
|
|
|
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: zh-Hans
|
|
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
|
+
|
|
25
|
+
其一,我不想做图书管理员。我有时想写下一些内容,但我可能还没有想好它的标题,还没有形成特别的组织。我希望 LLM 会自动帮我生成标题、做摘要、分类、导航等整理工作。
|
|
26
|
+
|
|
27
|
+
其二,我的书房必须打扫干净。我不想要配置复杂的构建工具,折腾复杂的文档配置,不喜欢复杂的结构。每次我看到 Docusaurus、VuePress、Astro 这些工具的配置文件和项目结构,我就头疼。现在,ZEN 选择将所有的配置都隐藏到 .zen 目录下,扫到角落里,用户只需要专注于写作内容,其他的交给 ZEN 来处理。其他的目录都是您的写作空间,您可以随意组织您的 Markdown 文件。
|
|
28
|
+
|
|
29
|
+
- 回归母语:用母语写作,丝滑构建多语言版本
|
|
30
|
+
|
|
31
|
+
人生苦短,我懒得翻译。人在使用母语时,才是最能发挥自身思考深度的。但同时与世界保持连接又是必要的,我不想放弃多语言的交流。于是我希望有一个工具,能让我用母语写作,同时又能让更多人看到我的内容。现在的 i18n 需要自己翻译不说,还得自己维护内容更新,太麻烦了。我选择使用 LLM 来帮我做翻译,省下了我很多时间,并且可以一键完成多国语言翻译。
|
|
32
|
+
|
|
33
|
+
## 基本功能
|
|
34
|
+
|
|
35
|
+
1. **静态站点生成**
|
|
36
|
+
- 将任意一个包含 Markdown 的文件夹构建成一个静态 HTML 站点
|
|
37
|
+
|
|
38
|
+
2. **智能导航**
|
|
39
|
+
- 生成站点地图和导航,不需要保持原始的 Markdown 源文件的目录结构,可以随意移动源文件。
|
|
40
|
+
|
|
41
|
+
3. **增量 i18n 翻译**
|
|
42
|
+
- 使用 LLM 进行增量 i18n 翻译,让用户使用母语编写 Markdown,但是用户可以是多语言的
|
|
43
|
+
|
|
44
|
+
## 设计理念
|
|
45
|
+
|
|
46
|
+
- **极简主义**: 最少的配置,最大的灵活性
|
|
47
|
+
- **内容优先**: 专注于写作,而不是工具配置
|
|
48
|
+
- **AI 赋能**: 利用 AI 处理翻译和内容组织
|
|
49
|
+
- **跨语言**: 支持多语言内容创作和展示
|
|
50
|
+
|
|
51
|
+
## 快速开始
|
|
52
|
+
|
|
53
|
+
### 推荐使用方式
|
|
54
|
+
|
|
55
|
+
**推荐用户切换到包含 Markdown 文件的目录下,直接使用以下命令开始构建:**
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
# 设置环境变量 (根据您的实际情况修改)
|
|
59
|
+
export OPENAI_API_KEY="sk-xxxxxx" # 必须:请替换为您的 OpenAI API Key
|
|
60
|
+
export OPENAI_BASE_URL="https://api.openai.com/v1" # 可选,默认使用 OpenAI 官方 API
|
|
61
|
+
export OPENAI_MODEL="gpt-3.5-turbo" # 可选,默认使用 gpt-3.5-turbo 模型
|
|
62
|
+
|
|
63
|
+
# 构建站点,支持多语言翻译
|
|
64
|
+
npx zengen@latest build --lang zh-Hans --lang en-US --verbose
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
**查看更多参数或帮助**:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx zengen
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
**注意**:ZEN 强制使用当前目录作为源目录,输出到 `.zen/dist` 目录。不支持指定源目录和输出目录参数。
|
|
@@ -0,0 +1,80 @@
|
|
|
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: zh-Hans
|
|
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
|
+
[Ruсть](https://zccz14.github.io/ZEN/ru-RU) |
|
|
21
|
+
[Français](https://zccz14.github.io/ZEN/fr-FR) |
|
|
22
|
+
[Deutsch](https://zccz14.github.io/ZEN/de-DE) |
|
|
23
|
+
[日本語](https://zccz14.github.io/ZEN/ja-JP) |
|
|
24
|
+
[한국어](https://zccz14.github.io/ZEN/ko-KR)
|
|
25
|
+
|
|
26
|
+
为什么又搞了个 Markdown 静态站点生成器?我重新思考了 AI 时代下,文档工具可以如何更好地服务于写作者:
|
|
27
|
+
|
|
28
|
+
- 回归内容:最小化打扰,专注写作
|
|
29
|
+
|
|
30
|
+
让文档回归本质,让写作回归宁静。
|
|
31
|
+
|
|
32
|
+
其一,我不想做图书管理员。我有时想写下一些内容,但我可能还没有想好它的标题,还没有形成特别的组织。我希望 LLM 会自动帮我生成标题、做摘要、分类、导航等整理工作。
|
|
33
|
+
|
|
34
|
+
其二,我的书房必须打扫干净。我不想要配置复杂的构建工具,折腾复杂的文档配置,不喜欢复杂的结构。每次我看到 Docusaurus、VuePress、Astro 这些工具的配置文件和项目结构,我就头疼。现在,ZEN 选择将所有的配置都隐藏到 .zen 目录下,扫到角落里,用户只需要专注于写作内容,其他的交给 ZEN 来处理。其他的目录都是您的写作空间,您可以随意组织您的 Markdown 文件。
|
|
35
|
+
|
|
36
|
+
- 回归母语:用母语写作,丝滑构建多语言版本
|
|
37
|
+
|
|
38
|
+
人生苦短,我懒得翻译。人在使用母语时,才是最能发挥自身思考深度的。但同时与世界保持连接又是必要的,我不想放弃多语言的交流。于是我希望有一个工具,能让我用母语写作,同时又能让更多人看到我的内容。现在的 i18n 需要自己翻译不说,还得自己维护内容更新,太麻烦了。我选择使用 LLM 来帮我做翻译,省下了我很多时间,并且可以一键完成多国语言翻译。
|
|
39
|
+
|
|
40
|
+
## 基本功能
|
|
41
|
+
|
|
42
|
+
1. **静态站点生成**
|
|
43
|
+
- 将任意一个包含 Markdown 的文件夹构建成一个静态 HTML 站点
|
|
44
|
+
|
|
45
|
+
2. **智能导航**
|
|
46
|
+
- 生成站点地图和导航,不需要保持原始的 Markdown 源文件的目录结构,可以随意移动源文件。
|
|
47
|
+
|
|
48
|
+
3. **增量 i18n 翻译**
|
|
49
|
+
- 使用 LLM 进行增量 i18n 翻译,让用户使用母语编写 Markdown,但是用户可以是多语言的
|
|
50
|
+
|
|
51
|
+
## 设计理念
|
|
52
|
+
|
|
53
|
+
- **极简主义**: 最少的配置,最大的灵活性
|
|
54
|
+
- **内容优先**: 专注于写作,而不是工具配置
|
|
55
|
+
- **AI 赋能**: 利用 AI 处理翻译和内容组织
|
|
56
|
+
- **跨语言**: 支持多语言内容创作和展示
|
|
57
|
+
|
|
58
|
+
## 快速开始
|
|
59
|
+
|
|
60
|
+
### 推荐使用方式
|
|
61
|
+
|
|
62
|
+
**推荐用户切换到包含 Markdown 文件的目录下,直接使用以下命令开始构建:**
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
# 设置环境变量 (根据您的实际情况修改)
|
|
66
|
+
export OPENAI_API_KEY="sk-xxxxxx" # 必须:请替换为您的 OpenAI API Key
|
|
67
|
+
export OPENAI_BASE_URL="https://api.openai.com/v1" # 可选,默认使用 OpenAI 官方 API
|
|
68
|
+
export OPENAI_MODEL="gpt-3.5-turbo" # 可选,默认使用 gpt-3.5-turbo 模型
|
|
69
|
+
|
|
70
|
+
# 构建站点,支持多语言翻译
|
|
71
|
+
npx zengen@latest build --lang zh-Hans --lang en-US --verbose
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
**查看更多参数或帮助**:
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
npx zengen
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
**注意**:ZEN 强制使用当前目录作为源目录,输出到 `.zen/dist` 目录。不支持指定源目录和输出目录参数。
|
|
@@ -0,0 +1,81 @@
|
|
|
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: zh-Hans
|
|
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` 目录。不支持指定源目录和输出目录参数。
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ZEN - 极简主义 Markdown + AI 静态站点构建器
|
|
3
|
+
summary: ZEN 是一个结合 AI 的静态站点生成器,支持智能分类导航和自动增量翻译,让用户专注于用母语写作,简化配置和构建过程。
|
|
4
|
+
tags:
|
|
5
|
+
- 静态站点生成器
|
|
6
|
+
- Markdown
|
|
7
|
+
- AI
|
|
8
|
+
- 多语言翻译
|
|
9
|
+
- 极简主义
|
|
10
|
+
- 文档工具
|
|
11
|
+
- Node.js
|
|
12
|
+
inferred_lang: zh-Hans
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - 极简主义 Markdown + AI 静态站点构建器
|
|
16
|
+
|
|
17
|
+
[> Website Demo](https://zccz14.github.io/ZEN/)
|
|
18
|
+
|
|
19
|
+
## 基本功能
|
|
20
|
+
|
|
21
|
+
1. 📃 **静态站点生成**:将任意一个包含 Markdown 的 git 文件夹构建成一个静态 HTML 站点。
|
|
22
|
+
2. 🧭 **智能分类导航**:使用 AI 进行内容分析,生成站点地图和导航,源文件的位置不敏感。
|
|
23
|
+
3. 🌍 **自动增量翻译**:使用 AI 进行增量翻译,让用户使用母语编写 Markdown,但是用户可以是多语言的。
|
|
24
|
+
|
|
25
|
+
为什么又搞了个 Markdown 静态站点生成器?我重新思考了 AI 时代下,文档工具可以如何更好地服务于写作者:
|
|
26
|
+
|
|
27
|
+
- 回归内容:最小化打扰,专注写作
|
|
28
|
+
|
|
29
|
+
让文档回归本质,让写作回归宁静。
|
|
30
|
+
|
|
31
|
+
其一,我不想做图书管理员。我有时想写下一些内容,但我可能还没有想好它的标题,还没有形成特别的组织。我希望 LLM 会自动帮我生成标题、做摘要、分类、导航等整理工作。
|
|
32
|
+
|
|
33
|
+
其二,我的书房必须打扫干净。我不想要配置复杂的构建工具,折腾复杂的文档配置,不喜欢复杂的结构。每次我看到 Docusaurus、VuePress、Astro 这些工具的配置文件和项目结构,我就头疼。现在,ZEN 选择将所有的配置都隐藏到 .zen 目录下,扫到角落里,用户只需要专注于写作内容,其他的交给 ZEN 来处理。其他的目录都是您的写作空间,您可以随意组织您的 Markdown 文件。
|
|
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 列出 Markdown 文件,忽略 .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,63 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ZEN - Markdown 文档站点构建工具
|
|
3
|
+
summary: ZEN 是一个极简的 Markdown 静态站点生成工具,强调内容优先,通过隐藏配置和 AI 赋能,让用户专注于母语写作,并支持多语言翻译和智能导航。
|
|
4
|
+
tags:
|
|
5
|
+
- Markdown
|
|
6
|
+
- 静态站点生成
|
|
7
|
+
- AI 翻译
|
|
8
|
+
- 多语言
|
|
9
|
+
- 极简主义
|
|
10
|
+
- 内容优先
|
|
11
|
+
- 文档工具
|
|
12
|
+
inferred_lang: zh-Hans
|
|
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 静态站点生成器?
|
|
20
|
+
|
|
21
|
+
- 回归内容:最小化打扰,让您专注写作
|
|
22
|
+
|
|
23
|
+
让文档回归本质,让写作回归宁静。我不想要配置复杂的构建工具,折腾复杂的文档配置,不喜欢复杂的结构。每次我看到 Docusaurus、VuePress、Astro 这些工具的配置文件和项目结构,我就头疼。现在,ZEN 选择将所有的配置都隐藏到 .zen 目录下,扫到角落里,用户只需要专注于写作内容,其他的交给 ZEN 来处理。其他的目录都是您的写作空间,您可以随意组织您的 Markdown 文件。LLM 还会自动帮您生成标题、做摘要、分类、生成导航等工作。您真的只需要专注于写作。
|
|
24
|
+
|
|
25
|
+
- 回归母语:仅用母语写作,丝滑构建多语言版本
|
|
26
|
+
|
|
27
|
+
人生苦短,我懒得翻译。人在使用母语时,才是最能发挥自身思考深度的。但同时与世界保持连接又是必要的,我不想放弃多语言的交流。于是我希望有一个工具,能让我用母语写作,同时又能让更多人看到我的内容。现在的 i18n 需要自己翻译不说,还得自己维护内容更新,太麻烦了。我选择使用 LLM 来帮我做翻译,省下了我很多时间,并且可以一键完成多国语言翻译。
|
|
28
|
+
|
|
29
|
+
## 基本功能
|
|
30
|
+
|
|
31
|
+
1. **静态站点生成**
|
|
32
|
+
- 将任意一个包含 Markdown 的文件夹构建成一个静态 HTML 站点
|
|
33
|
+
|
|
34
|
+
2. **智能导航**
|
|
35
|
+
- 生成站点地图和导航,不需要保持原始的 Markdown 源文件的目录结构
|
|
36
|
+
|
|
37
|
+
3. **增量 i18n 翻译**
|
|
38
|
+
- 使用 LLM 进行增量 i18n 翻译,让用户使用母语编写 Markdown,但是用户可以是多语言的
|
|
39
|
+
|
|
40
|
+
## 设计理念
|
|
41
|
+
|
|
42
|
+
- **极简主义**: 最少的配置,最大的灵活性
|
|
43
|
+
- **内容优先**: 专注于写作,而不是工具配置
|
|
44
|
+
- **AI 赋能**: 利用 AI 处理翻译和内容组织
|
|
45
|
+
- **跨语言**: 支持多语言内容创作和展示
|
|
46
|
+
|
|
47
|
+
## 快速开始
|
|
48
|
+
|
|
49
|
+
### 推荐使用方式
|
|
50
|
+
|
|
51
|
+
**推荐用户切换到包含 Markdown 文件的目录下,直接使用以下命令开始构建:**
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
npx zengen build
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
**查看更多参数或帮助**:
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
npx zengen
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
**注意**:ZEN 强制使用当前目录作为源目录,输出到 `.zen/dist` 目录。不支持指定源目录和输出目录参数。
|