zengen 0.2.0 → 0.2.2
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 +4 -4
- package/.zen/meta.json +8 -139
- package/.zen/src/de-DE/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
- package/.zen/src/de-DE/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
- package/.zen/src/en-US/01d04f7c17b4a541ead9d759d877b30b403e15b849182a49eb1f62bd29ecd18c.md +23 -23
- package/.zen/src/en-US/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
- package/.zen/src/en-US/1b798c44a4f353e47296ca83d5905e37e6aba3e90bbd9bc3b3d34fc12059a2ca.md +2 -2
- package/.zen/src/en-US/1e96be58d76c60056b708eb5bd8b8b81d7b5845d9cfe0b879d85068a5f11df3a.md +3 -3
- package/.zen/src/en-US/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
- package/.zen/src/en-US/80ae9bed74fc6348a7c1fe9f33e86b65f5d919169721f77bcf0e1bc29fbdb4f9.md +3 -3
- package/.zen/src/en-US/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md +63 -0
- package/.zen/src/en-US/f0c2799126931ccd113a0c45b1e623870b0d4f4f400becf6dd877da8f1011517.md +2 -3
- package/.zen/src/en-US/fdfca9b960d0eaa8b2b96fe988ead7481d2c0b16f66ebc94fb477139b4178cdc.md +5 -5
- package/.zen/src/es-ES/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
- package/.zen/src/es-ES/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
- package/.zen/src/fr-FR/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
- package/.zen/src/fr-FR/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
- package/.zen/src/ja-JP/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +71 -0
- package/.zen/src/ja-JP/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
- package/.zen/src/ko-KR/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
- package/.zen/src/pt-PT/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
- package/.zen/src/pt-PT/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -0
- package/.zen/src/ru-RU/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +73 -0
- package/.zen/src/ru-RU/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +81 -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/6124ea88edec5bde737b26b21f71ecfeffe4e73151784856edf813ee231a4baa.md +10 -0
- package/.zen/src/zh-Hans/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md +63 -0
- package/.zen/src/zh-Hans/f0c2799126931ccd113a0c45b1e623870b0d4f4f400becf6dd877da8f1011517.md +3 -4
- package/.zen/src/zh-Hans/fdfca9b960d0eaa8b2b96fe988ead7481d2c0b16f66ebc94fb477139b4178cdc.md +2 -2
- package/README.md +27 -21
- package/dist/build/pipeline.d.ts.map +1 -1
- package/dist/build/pipeline.js +13 -12
- package/dist/build/pipeline.js.map +1 -1
- package/dist/languages.d.ts +2 -0
- package/dist/languages.d.ts.map +1 -0
- package/dist/languages.js +14 -0
- package/dist/languages.js.map +1 -0
- package/dist/process/extractMetadataByAI.d.ts.map +1 -1
- package/dist/process/extractMetadataByAI.js +3 -3
- package/dist/process/extractMetadataByAI.js.map +1 -1
- package/dist/process/template.d.ts.map +1 -1
- package/dist/process/template.js +2 -7
- package/dist/process/template.js.map +1 -1
- package/package.json +2 -2
- package/src/build/pipeline.ts +48 -42
- package/src/languages.ts +10 -0
- package/src/process/extractMetadataByAI.ts +14 -12
- package/src/process/template.ts +2 -7
- package/.zen/src/zh-Hans/6ad8db715a1b60613fe934fefb29fa981ecad9b63145593accff144d73b44bde.md +0 -175
- package/.zen/src/zh-Hans/a1580f71c6c6c1ff4a314be72d410a8507af2f087d56360c7f5048d349c21953.md +0 -48
- package/.zen/src/zh-Hans/d49012f98c4367b34034063400e2f7826bf0615952210c82396920172d468e2c.md +0 -107
- 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,81 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ZEN - 마크다운 문서 사이트 빌드 도구
|
|
3
|
+
summary: ZEN은 내용 중심과 극도의 간결함을 강조하는 깔끔한 마크다운 정적 사이트 생성 도구입니다. AI를 활용한 지능형 탐색 및 다국어 번역을 통해 사용자가 복잡한 설정 없이 글쓰기에 집중할 수 있도록 돕습니다.
|
|
4
|
+
tags:
|
|
5
|
+
- Markdown
|
|
6
|
+
- 정적 사이트 생성
|
|
7
|
+
- AI 번역
|
|
8
|
+
- 다국어
|
|
9
|
+
- 미니멀리즘
|
|
10
|
+
- 문서 도구
|
|
11
|
+
- ZEN
|
|
12
|
+
inferred_lang: ko-KR
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - 깔끔한 마크다운 문서 사이트 빌드 도구
|
|
16
|
+
|
|
17
|
+
[简体中文](https://zccz14.github.io/ZEN/zh-Hans) |
|
|
18
|
+
[English](https://zccz14.github.io/ZEN/en-US) |
|
|
19
|
+
[Español](https://zccz14.github.io/ZEN/es-ES) |
|
|
20
|
+
[Português](https://zccz14.github.io/ZEN/pt-PT) |
|
|
21
|
+
[Русский](https://zccz14.github.io/ZEN/ru-RU) |
|
|
22
|
+
[Français](https://zccz14.github.io/ZEN/fr-FR) |
|
|
23
|
+
[日本語](https://zccz14.github.io/ZEN/ja-JP) |
|
|
24
|
+
[한국어](https://zccz14.github.io/ZEN/ko-KR) |
|
|
25
|
+
[Deutsch](https://zccz14.github.io/ZEN/de-DE) |
|
|
26
|
+
|
|
27
|
+
왜 또 다른 마크다운 정적 사이트 생성기를 만들었을까요? AI 시대에 문서 도구가 글쓰는 사람에게 어떻게 더 잘 서비스할 수 있을지 다시 생각해보았습니다:
|
|
28
|
+
|
|
29
|
+
- **내용으로의 회귀**: 최소한의 방해, 글쓰기에 집중
|
|
30
|
+
|
|
31
|
+
문서의 본질과 글쓰기의 평온함으로 돌아갑니다.
|
|
32
|
+
|
|
33
|
+
첫째, 저는 도서관 사서가 되고 싶지 않습니다. 때로는 내용을 적고 싶지만, 아직 제목을 정하지 못했거나 특별한 체계를 갖추지 못한 경우가 있습니다. LLM이 자동으로 제목을 생성하고, 요약하고, 분류하고, 탐색하는 등의 정리 작업을 해주길 바랍니다.
|
|
34
|
+
|
|
35
|
+
둘째, 제 서재는 반드시 깨끗해야 합니다. 복잡한 구성 도구를 설정하거나, 복잡한 문서 구성을 꾸미는 것을 원하지 않으며, 복잡한 구조를 좋아하지 않습니다. Docusaurus, VuePress, Astro 같은 도구들의 설정 파일과 프로젝트 구조를 볼 때마다 머리가 아픕니다. 이제 ZEN은 모든 구성을 `.zen` 디렉토리 안에 숨겨 구석으로 치우기로 선택했습니다. 사용자는 글쓰기 내용에만 집중하면 되며, 나머지는 ZEN이 처리합니다. 다른 디렉토리들은 모두 여러분의 글쓰기 공간이며, 마크다운 파일을 자유롭게 구성할 수 있습니다.
|
|
36
|
+
|
|
37
|
+
- **모국어로의 회귀**: 모국어로 글쓰고, 부드러운 다국어 버전 빌드
|
|
38
|
+
|
|
39
|
+
인생은 짧습니다. 저는 번역하기 귀찮습니다. 사람은 모국어를 사용할 때 가장 깊이 생각할 수 있습니다. 하지만 동시에 세계와 연결을 유지하는 것도 필요하며, 다국어 소통을 포기하고 싶지 않습니다. 그래서 저는 모국어로 글을 쓰면서도 더 많은 사람들이 제 내용을 볼 수 있도록 해주는 도구를 원했습니다. 현재의 i18n은 직접 번역해야 할 뿐만 아니라 내용 업데이트도 직접 관리해야 하니 너무 번거롭습니다. 저는 LLM을 사용하여 번역을 도와주도록 선택했고, 많은 시간을 절약하며 한 번의 클릭으로 여러 국가 언어 번역을 완료할 수 있습니다.
|
|
40
|
+
|
|
41
|
+
## 기본 기능
|
|
42
|
+
|
|
43
|
+
1. **정적 사이트 생성**
|
|
44
|
+
- 마크다운 파일이 포함된 임의의 폴더를 정적 HTML 사이트로 빌드합니다.
|
|
45
|
+
|
|
46
|
+
2. **지능형 탐색**
|
|
47
|
+
- 사이트맵과 탐색을 생성합니다. 원본 마크다운 소스 파일의 디렉토리 구조를 유지할 필요가 없으며, 소스 파일을 자유롭게 이동할 수 있습니다.
|
|
48
|
+
|
|
49
|
+
3. **증분 i18n 번역**
|
|
50
|
+
- LLM을 사용한 증분 i18n 번역으로, 사용자가 모국어로 마크다운을 작성하지만 다국어 사용자가 될 수 있도록 합니다.
|
|
51
|
+
|
|
52
|
+
## 디자인 철학
|
|
53
|
+
|
|
54
|
+
- **미니멀리즘**: 최소한의 구성, 최대의 유연성
|
|
55
|
+
- **내용 우선**: 도구 구성이 아닌 글쓰기에 집중
|
|
56
|
+
- **AI 활용**: AI를 활용한 번역 및 내용 구성
|
|
57
|
+
- **다국어 지원**: 다국어 콘텐츠 제작 및 표시 지원
|
|
58
|
+
|
|
59
|
+
## 빠른 시작
|
|
60
|
+
|
|
61
|
+
### 권장 사용 방법
|
|
62
|
+
|
|
63
|
+
**사용자는 마크다운 파일이 포함된 디렉토리로 전환한 후, 아래 명령어를 직접 사용하여 빌드를 시작하는 것을 권장합니다:**
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
# 환경 변수 설정 (실제 상황에 맞게 수정)
|
|
67
|
+
export OPENAI_API_KEY="sk-xxxxxx" # 필수: 귀하의 OpenAI API Key로 교체하세요
|
|
68
|
+
export OPENAI_BASE_URL="https://api.openai.com/v1" # 선택 사항, 기본값은 OpenAI 공식 API 사용
|
|
69
|
+
export OPENAI_MODEL="gpt-3.5-turbo" # 선택 사항, 기본값은 gpt-3.5-turbo 모델 사용
|
|
70
|
+
|
|
71
|
+
# 사이트 빌드, 다국어 번역 지원
|
|
72
|
+
npx zengen@latest build --lang zh-Hans --lang en-US --verbose
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
**더 많은 매개변수 또는 도움말 보기**:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
npx zengen
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
**참고**: ZEN은 현재 디렉토리를 소스 디렉토리로 사용하고, `.zen/dist` 디렉토리에 출력하도록 강제합니다. 소스 디렉토리와 출력 디렉토리 매개변수 지정을 지원하지 않습니다.
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ZEN - Ferramenta de Construção de Sites de Documentação em Markdown
|
|
3
|
+
summary: O ZEN é uma ferramenta minimalista de geração de sites estáticos em Markdown, focada na escrita de conteúdo, utilizando IA para processar tradução e navegação, suportando construção multilíngue sem configuração complexa.
|
|
4
|
+
tags:
|
|
5
|
+
- Markdown
|
|
6
|
+
- Gerador de Sites Estáticos
|
|
7
|
+
- Tradução por IA
|
|
8
|
+
- Multilíngue
|
|
9
|
+
- Minimalismo
|
|
10
|
+
- Ferramenta de Documentação
|
|
11
|
+
- ZEN
|
|
12
|
+
inferred_lang: pt-PT
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Ferramenta de Construção de Sites de Documentação em Markdown
|
|
16
|
+
|
|
17
|
+
[简体中文](https://zccz14.github.io/ZEN/zh-Hans) | [English](https://zccz14.github.io/ZEN/en-US)
|
|
18
|
+
|
|
19
|
+
Por que criar mais um gerador de sites estáticos em Markdown? Refliti sobre como as ferramentas de documentação podem servir melhor os escritores na era da IA:
|
|
20
|
+
|
|
21
|
+
- **Regresso ao conteúdo**: Minimizar distrações, focar na escrita
|
|
22
|
+
|
|
23
|
+
Devolver a essência à documentação e a serenidade à escrita.
|
|
24
|
+
|
|
25
|
+
Primeiro, não quero ser um bibliotecário. Às vezes quero escrever algo, mas talvez ainda não tenha pensado no título ou na organização. Quero que um LLM gere automaticamente títulos, resumos, categorias, navegação e outras tarefas de organização.
|
|
26
|
+
|
|
27
|
+
Segundo, o meu escritório deve estar arrumado. Não quero ferramentas de construção com configurações complexas, nem estruturas complicadas. Sempre que vejo os ficheiros de configuração e estruturas de projetos de ferramentas como Docusaurus, VuePress ou Astro, fico com dor de cabeça. Agora, o ZEN opta por esconder toda a configuração no diretório `.zen`, varrendo-a para um canto. O utilizador só precisa de se concentrar em escrever o conteúdo; o resto é tratado pelo ZEN. Todos os outros diretórios são o seu espaço de escrita, onde pode organizar os seus ficheiros Markdown como desejar.
|
|
28
|
+
|
|
29
|
+
- **Regresso à língua materna**: Escrever na língua materna, construir versões multilíngues de forma fluida
|
|
30
|
+
|
|
31
|
+
A vida é curta, não tenho paciência para traduzir. É na língua materna que conseguimos expressar a nossa profundidade de pensamento. No entanto, manter a ligação com o mundo é necessário, e não quero abdicar da comunicação multilíngue. Por isso, desejo uma ferramenta que me permita escrever na minha língua materna e, ao mesmo tempo, tornar o meu conteúdo acessível a mais pessoas. Atualmente, a i18n exige que traduzamos e mantenhamos as atualizações de conteúdo, o que é muito trabalhoso. Opto por usar LLM para me ajudar com as traduções, poupando muito tempo e permitindo a tradução para vários idiomas com um único clique.
|
|
32
|
+
|
|
33
|
+
## Funcionalidades Básicas
|
|
34
|
+
|
|
35
|
+
1. **Geração de Sites Estáticos**
|
|
36
|
+
- Constrói um site HTML estático a partir de qualquer pasta que contenha ficheiros Markdown.
|
|
37
|
+
|
|
38
|
+
2. **Navegação Inteligente**
|
|
39
|
+
- Gera um mapa do site e navegação, sem necessidade de manter a estrutura de diretórios original dos ficheiros Markdown de origem. Pode mover os ficheiros de origem livremente.
|
|
40
|
+
|
|
41
|
+
3. **Tradução i18n Incremental**
|
|
42
|
+
- Utiliza LLM para tradução i18n incremental, permitindo que os utilizadores escrevam Markdown na sua língua materna, mas possam ter conteúdo multilíngue.
|
|
43
|
+
|
|
44
|
+
## Filosofia de Design
|
|
45
|
+
|
|
46
|
+
- **Minimalismo**: Configuração mínima, máxima flexibilidade.
|
|
47
|
+
- **Prioridade ao Conteúdo**: Foco na escrita, não na configuração da ferramenta.
|
|
48
|
+
- **Potenciado por IA**: Utiliza IA para processar tradução e organização de conteúdo.
|
|
49
|
+
- **Translinguístico**: Suporta criação e exibição de conteúdo multilíngue.
|
|
50
|
+
|
|
51
|
+
## Início Rápido
|
|
52
|
+
|
|
53
|
+
### Modo de Uso Recomendado
|
|
54
|
+
|
|
55
|
+
**Recomenda-se que os utilizadores mudem para o diretório que contém os ficheiros Markdown e usem diretamente o seguinte comando para começar a construção:**
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
# Definir variáveis de ambiente (modifique conforme a sua situação real)
|
|
59
|
+
export OPENAI_API_KEY="sk-xxxxxx" # Obrigatório: substitua pela sua chave de API da OpenAI
|
|
60
|
+
export OPENAI_BASE_URL="https://api.openai.com/v1" # Opcional, usa a API oficial da OpenAI por padrão
|
|
61
|
+
export OPENAI_MODEL="gpt-3.5-turbo" # Opcional, usa o modelo gpt-3.5-turbo por padrão
|
|
62
|
+
|
|
63
|
+
# Construir o site, com suporte a tradução multilíngue
|
|
64
|
+
npx zengen@latest build --lang pt-PT --lang en-US --verbose
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
**Ver mais parâmetros ou ajuda**:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
npx zengen
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
**Nota**: O ZEN obriga a usar o diretório atual como diretório de origem, com saída para o diretório `.zen/dist`. Não suporta a especificação de parâmetros de diretório de origem ou de saída.
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ZEN - Ferramenta de Construção de Sites de Documentação em Markdown
|
|
3
|
+
summary: O ZEN é uma ferramenta de geração de sites estáticos em Markdown, focada na prioridade do conteúdo e no minimalismo. Utiliza IA para navegação inteligente e tradução multilíngue, ajudando os utilizadores a concentrarem-se na escrita sem configurações complexas.
|
|
4
|
+
tags:
|
|
5
|
+
- Markdown
|
|
6
|
+
- Geração de Sites Estáticos
|
|
7
|
+
- Tradução por IA
|
|
8
|
+
- Multilíngue
|
|
9
|
+
- Minimalismo
|
|
10
|
+
- Ferramenta de Documentação
|
|
11
|
+
- ZEN
|
|
12
|
+
inferred_lang: pt-PT
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# ZEN - Ferramenta de Construção de Sites de Documentação em 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
|
+
Porque criar mais um gerador de sites estáticos em Markdown? Refliti sobre como as ferramentas de documentação podem servir melhor os escritores na era da IA:
|
|
28
|
+
|
|
29
|
+
- **Regresso ao conteúdo**: Minimizar distrações, focar na escrita
|
|
30
|
+
|
|
31
|
+
Devolver a essência à documentação, devolver a tranquilidade à escrita.
|
|
32
|
+
|
|
33
|
+
Primeiro, não quero ser um bibliotecário. Às vezes quero escrever algo, mas talvez ainda não tenha pensado no título, ou não tenha uma organização específica. Espero que a LLM me ajude automaticamente a gerar títulos, fazer resumos, classificar, navegar e outras tarefas de organização.
|
|
34
|
+
|
|
35
|
+
Segundo, o meu escritório tem de estar arrumado. Não quero ferramentas de construção com configurações complexas, não gosto de estruturas complicadas. Sempre que vejo os ficheiros de configuração e a estrutura de projetos de ferramentas como Docusaurus, VuePress, Astro, fico com dor de cabeça. Agora, o ZEN opta por esconder todas as configurações no diretório `.zen`, varrendo-as para um canto. O utilizador só precisa de se concentrar no conteúdo da escrita, o resto é tratado pelo ZEN. Todos os outros diretórios são o seu espaço de escrita, pode organizar os seus ficheiros Markdown como quiser.
|
|
36
|
+
|
|
37
|
+
- **Regresso à língua materna**: Escrever na língua materna, construir versões multilíngue de forma fluida
|
|
38
|
+
|
|
39
|
+
A vida é curta, não tenho paciência para traduzir. É na língua materna que conseguimos explorar melhor a profundidade do nosso pensamento. Mas, ao mesmo tempo, manter a ligação com o mundo é necessário, não quero abdicar da comunicação multilíngue. Por isso, desejo uma ferramenta que me permita escrever na minha língua materna e, ao mesmo tempo, permita que mais pessoas vejam o meu conteúdo. Atualmente, o i18n exige que traduzamos nós próprios e ainda temos de manter as atualizações de conteúdo, é muito trabalhoso. Opto por usar a LLM para me ajudar com as traduções, poupando muito tempo e permitindo a tradução para vários idiomas com um único clique.
|
|
40
|
+
|
|
41
|
+
## Funcionalidades Básicas
|
|
42
|
+
|
|
43
|
+
1. **Geração de Sites Estáticos**
|
|
44
|
+
- Constrói uma pasta qualquer que contenha ficheiros Markdown num site HTML estático.
|
|
45
|
+
|
|
46
|
+
2. **Navegação Inteligente**
|
|
47
|
+
- Gera um mapa do site e navegação. Não é necessário manter a estrutura de diretórios original dos ficheiros Markdown de origem; pode mover os ficheiros de origem livremente.
|
|
48
|
+
|
|
49
|
+
3. **Tradução i18n Incremental**
|
|
50
|
+
- Utiliza LLM para tradução i18n incremental, permitindo que os utilizadores escrevam Markdown na sua língua materna, mas possam ter conteúdo multilíngue.
|
|
51
|
+
|
|
52
|
+
## Filosofia de Design
|
|
53
|
+
|
|
54
|
+
- **Minimalismo**: Configuração mínima, flexibilidade máxima.
|
|
55
|
+
- **Prioridade ao Conteúdo**: Foco na escrita, não na configuração da ferramenta.
|
|
56
|
+
- **Potenciado por IA**: Utiliza IA para processar tradução e organização de conteúdo.
|
|
57
|
+
- **Translinguístico**: Suporta criação e exibição de conteúdo multilíngue.
|
|
58
|
+
|
|
59
|
+
## Início Rápido
|
|
60
|
+
|
|
61
|
+
### Modo de Utilização Recomendado
|
|
62
|
+
|
|
63
|
+
**Recomenda-se que os utilizadores mudem para o diretório que contém os ficheiros Markdown e utilizem diretamente o seguinte comando para começar a construção:**
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
# Definir variáveis de ambiente (modificar de acordo com a sua situação real)
|
|
67
|
+
export OPENAI_API_KEY="sk-xxxxxx" # Obrigatório: substitua pela sua Chave de API da OpenAI
|
|
68
|
+
export OPENAI_BASE_URL="https://api.openai.com/v1" # Opcional, por padrão utiliza a API oficial da OpenAI
|
|
69
|
+
export OPENAI_MODEL="gpt-3.5-turbo" # Opcional, por padrão utiliza o modelo gpt-3.5-turbo
|
|
70
|
+
|
|
71
|
+
# Construir o site, suporta tradução multilíngue
|
|
72
|
+
npx zengen@latest build --lang pt-PT --lang en-US --verbose
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
**Ver mais parâmetros ou ajuda**:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
npx zengen
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
**Nota**: O ZEN obriga a utilizar o diretório atual como diretório de origem, com saída para o diretório `.zen/dist`. Não suporta a especificação de parâmetros de diretório de origem e diretório de saída.
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ZEN - Инструмент для создания сайтов документации на Markdown
|
|
3
|
+
summary: ZEN — это минималистичный генератор статических сайтов на Markdown, ориентированный на написание контента. Использует ИИ для обработки перевода и навигации, поддерживает многоязычную сборку без сложной конфигурации.
|
|
4
|
+
tags:
|
|
5
|
+
- Markdown
|
|
6
|
+
- Генератор статических сайтов
|
|
7
|
+
- ИИ-перевод
|
|
8
|
+
- Мультиязычность
|
|
9
|
+
- Минимализм
|
|
10
|
+
- Инструмент для документации
|
|
11
|
+
- ZEN
|
|
12
|
+
inferred_lang: ru-RU
|
|
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
|
+
Вернуть документации её суть, а письму — спокойствие.
|
|
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
|
+
- **Расширение возможностей с помощью ИИ**: Использование ИИ для обработки перевода и организации контента.
|
|
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,81 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ZEN - Инструмент для создания сайтов документации на Markdown
|
|
3
|
+
summary: ZEN — это простой генератор статических сайтов на Markdown, ориентированный на контент и минимализм. Использует ИИ для интеллектуальной навигации и многоязычного перевода, помогая пользователям сосредоточиться на написании текстов без сложных настроек.
|
|
4
|
+
tags:
|
|
5
|
+
- Markdown
|
|
6
|
+
- Генератор статических сайтов
|
|
7
|
+
- ИИ-перевод
|
|
8
|
+
- Многоязычность
|
|
9
|
+
- Минимализм
|
|
10
|
+
- Инструмент для документации
|
|
11
|
+
- ZEN
|
|
12
|
+
inferred_lang: ru-RU
|
|
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? Я задумался о том, как инструменты для документации могут лучше служить авторам в эпоху ИИ:
|
|
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
|
+
- **ИИ-возможности**: Использование ИИ для обработки перевода и организации контента.
|
|
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" # Опционально, по умолчанию используется официальный API OpenAI
|
|
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,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` 目录。不支持指定源目录和输出目录参数。
|