zengen 0.2.4 → 0.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.zen/meta.json +27 -18
- package/.zen/src/ar-SA/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +36 -36
- package/.zen/src/ar-SA/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/da-DK/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +29 -29
- package/.zen/src/da-DK/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/de-DE/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +24 -24
- package/.zen/src/de-DE/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/en-US/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +27 -27
- package/.zen/src/en-US/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/es-ES/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +34 -34
- package/.zen/src/es-ES/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/es-MX/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +31 -31
- package/.zen/src/es-MX/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/fi-FI/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +30 -30
- package/.zen/src/fi-FI/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/fr-FR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +26 -26
- package/.zen/src/fr-FR/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/hi-IN/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +29 -29
- package/.zen/src/hi-IN/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/id-ID/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +27 -27
- package/.zen/src/id-ID/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/it-IT/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +38 -38
- package/.zen/src/it-IT/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/ja-JP/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +27 -27
- package/.zen/src/ja-JP/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/ko-KR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +25 -25
- package/.zen/src/ko-KR/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/nl-NL/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +31 -31
- package/.zen/src/nl-NL/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/no-NO/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +32 -32
- package/.zen/src/no-NO/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/pl-PL/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +27 -27
- package/.zen/src/pl-PL/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/pt-BR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +34 -34
- package/.zen/src/pt-BR/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/pt-PT/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +28 -28
- package/.zen/src/pt-PT/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/ru-RU/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +37 -37
- package/.zen/src/ru-RU/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/sv-SE/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +29 -29
- package/.zen/src/sv-SE/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/th-TH/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +30 -30
- package/.zen/src/th-TH/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/tr-TR/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +31 -31
- package/.zen/src/tr-TR/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/uk-UA/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +30 -30
- package/.zen/src/uk-UA/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/vi-VN/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +24 -24
- package/.zen/src/vi-VN/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +30 -0
- package/.zen/src/zh-Hans/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +14 -11
- package/.zen/src/zh-Hans/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +31 -0
- package/.zen/src/zh-Hant/74541be9d53c64107a548e09847244d52bff803960942cd2bfbd2a8600afb805.md +18 -15
- package/.zen/src/zh-Hant/9d0485c244a80b14dcc92ef91cf5ff82220ed774ebb5e09549929ac75200c7bc.md +31 -0
- package/dist/ai/extractMetadataFromMarkdown.js +3 -3
- package/dist/ai/extractMetadataFromMarkdown.js.map +1 -1
- package/dist/process/template.d.ts.map +1 -1
- package/dist/process/template.js +8 -5
- package/dist/process/template.js.map +1 -1
- package/dist/utils/frontmatter.js +1 -1
- package/dist/utils/frontmatter.js.map +1 -1
- package/docs/tricks.md +15 -0
- package/package.json +1 -1
- package/src/ai/extractMetadataFromMarkdown.ts +3 -3
- package/src/process/template.ts +10 -9
- package/src/utils/frontmatter.ts +1 -1
- package/.zen/src/de-DE/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
- package/.zen/src/de-DE/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/en-US/01d04f7c17b4a541ead9d759d877b30b403e15b849182a49eb1f62bd29ecd18c.md +0 -120
- package/.zen/src/en-US/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
- package/.zen/src/en-US/1b798c44a4f353e47296ca83d5905e37e6aba3e90bbd9bc3b3d34fc12059a2ca.md +0 -75
- package/.zen/src/en-US/1e96be58d76c60056b708eb5bd8b8b81d7b5845d9cfe0b879d85068a5f11df3a.md +0 -189
- package/.zen/src/en-US/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/en-US/5ec990146b35e00de2630559126ee07f7cdcddeb23b0e8cab3d85b4181353e26.md +0 -53
- package/.zen/src/en-US/6124ea88edec5bde737b26b21f71ecfeffe4e73151784856edf813ee231a4baa.md +0 -11
- package/.zen/src/en-US/80ae9bed74fc6348a7c1fe9f33e86b65f5d919169721f77bcf0e1bc29fbdb4f9.md +0 -61
- package/.zen/src/en-US/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md +0 -63
- package/.zen/src/en-US/f0c2799126931ccd113a0c45b1e623870b0d4f4f400becf6dd877da8f1011517.md +0 -40
- package/.zen/src/en-US/fdfca9b960d0eaa8b2b96fe988ead7481d2c0b16f66ebc94fb477139b4178cdc.md +0 -65
- package/.zen/src/es-ES/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
- package/.zen/src/es-ES/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/fr-FR/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
- package/.zen/src/fr-FR/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/ja-JP/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -71
- package/.zen/src/ja-JP/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/ko-KR/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/pt-PT/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
- package/.zen/src/pt-PT/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/ru-RU/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
- package/.zen/src/ru-RU/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/zh-Hans/01d04f7c17b4a541ead9d759d877b30b403e15b849182a49eb1f62bd29ecd18c.md +0 -120
- package/.zen/src/zh-Hans/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md +0 -73
- package/.zen/src/zh-Hans/084ef1f6a0167df8621c673c79211309d4af6c588e7bbe3e043f7c244edd0ac6.md +0 -80
- package/.zen/src/zh-Hans/1b798c44a4f353e47296ca83d5905e37e6aba3e90bbd9bc3b3d34fc12059a2ca.md +0 -77
- package/.zen/src/zh-Hans/1e96be58d76c60056b708eb5bd8b8b81d7b5845d9cfe0b879d85068a5f11df3a.md +0 -189
- package/.zen/src/zh-Hans/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md +0 -81
- package/.zen/src/zh-Hans/5ec990146b35e00de2630559126ee07f7cdcddeb23b0e8cab3d85b4181353e26.md +0 -55
- package/.zen/src/zh-Hans/6124ea88edec5bde737b26b21f71ecfeffe4e73151784856edf813ee231a4baa.md +0 -11
- package/.zen/src/zh-Hans/80ae9bed74fc6348a7c1fe9f33e86b65f5d919169721f77bcf0e1bc29fbdb4f9.md +0 -63
- package/.zen/src/zh-Hans/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md +0 -63
- package/.zen/src/zh-Hans/f0c2799126931ccd113a0c45b1e623870b0d4f4f400becf6dd877da8f1011517.md +0 -40
- package/.zen/src/zh-Hans/fdfca9b960d0eaa8b2b96fe988ead7481d2c0b16f66ebc94fb477139b4178cdc.md +0 -65
|
@@ -1,73 +0,0 @@
|
|
|
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.
|
|
@@ -1,81 +0,0 @@
|
|
|
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.
|
|
@@ -1,73 +0,0 @@
|
|
|
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`. Параметры для указания исходного и выходного каталогов не поддерживаются.
|
|
@@ -1,81 +0,0 @@
|
|
|
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`. Не поддерживается указание параметров исходного и выходного каталогов.
|
package/.zen/src/zh-Hans/01d04f7c17b4a541ead9d759d877b30b403e15b849182a49eb1f62bd29ecd18c.md
DELETED
|
@@ -1,120 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: GitHub Pages 部署配置
|
|
3
|
-
summary: 本文档介绍了 ZEN 项目文档站点的 GitHub Pages 部署配置,包括工作流程、触发条件、构建步骤、自定义配置、故障排除和手动触发方法。
|
|
4
|
-
tags:
|
|
5
|
-
- GitHub Pages
|
|
6
|
-
- 部署配置
|
|
7
|
-
- 工作流程
|
|
8
|
-
- 文档构建
|
|
9
|
-
- 故障排除
|
|
10
|
-
- ZEN 项目
|
|
11
|
-
inferred_lang: zh-Hans
|
|
12
|
-
---
|
|
13
|
-
|
|
14
|
-
# GitHub Pages 部署配置
|
|
15
|
-
|
|
16
|
-
此目录包含 ZEN 项目文档站点的 GitHub Pages 部署配置。
|
|
17
|
-
|
|
18
|
-
## 工作流程
|
|
19
|
-
|
|
20
|
-
### `pages.yml`
|
|
21
|
-
|
|
22
|
-
此工作流程会自动构建 ZEN 项目的文档站点并部署到 GitHub Pages。
|
|
23
|
-
|
|
24
|
-
**触发条件:**
|
|
25
|
-
|
|
26
|
-
- 推送到 `main` 分支(当 `demo/src/`、`package.json` 或工作流程文件发生变化时)
|
|
27
|
-
- 针对 `main` 分支的 Pull Request
|
|
28
|
-
- 手动触发
|
|
29
|
-
|
|
30
|
-
**工作流程步骤:**
|
|
31
|
-
|
|
32
|
-
1. **检出代码**:从远程分支检出代码,确保代码同步
|
|
33
|
-
2. **设置 Node.js**:配置 Node.js 20.x 环境
|
|
34
|
-
3. **安装依赖**:使用 `npm ci` 安装项目依赖
|
|
35
|
-
4. **构建 zengen**:构建本地 zengen 包
|
|
36
|
-
5. **安装 zengen**:将本地构建的 zengen 安装为全局工具
|
|
37
|
-
6. **测试 zengen CLI**:验证 CLI 工具正常工作
|
|
38
|
-
7. **构建文档站点**:使用 `cd demo/src && zengen build` 构建文档,输出到 `.zen/dist` 目录
|
|
39
|
-
8. **配置 Pages**:设置 GitHub Pages
|
|
40
|
-
9. **上传制品**:将构建的文档站点上传为 Pages 制品
|
|
41
|
-
10. **部署到 GitHub Pages**:自动部署到 GitHub Pages
|
|
42
|
-
|
|
43
|
-
## 访问文档站点
|
|
44
|
-
|
|
45
|
-
部署成功后,文档站点将可通过以下 URL 访问:
|
|
46
|
-
|
|
47
|
-
```
|
|
48
|
-
https://[用户名].github.io/[仓库名]/
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
## 自定义配置
|
|
52
|
-
|
|
53
|
-
### 自定义域名
|
|
54
|
-
|
|
55
|
-
如果需要使用自定义域名,可以在构建步骤后添加 CNAME 文件:
|
|
56
|
-
|
|
57
|
-
```yaml
|
|
58
|
-
# 创建 CNAME 文件(如果需要自定义域名)
|
|
59
|
-
echo "docs.example.com" > docs-dist/CNAME
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
### 构建选项
|
|
63
|
-
|
|
64
|
-
当前使用的构建命令:
|
|
65
|
-
|
|
66
|
-
```bash
|
|
67
|
-
cd demo/src
|
|
68
|
-
zengen build --verbose
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
可用的选项:
|
|
72
|
-
|
|
73
|
-
- `--verbose`:显示详细输出
|
|
74
|
-
- `--watch`:监听模式(不适用于 CI/CD)
|
|
75
|
-
- `--template`:指定自定义模板文件
|
|
76
|
-
- `--config`:指定配置文件
|
|
77
|
-
|
|
78
|
-
### 环境变量
|
|
79
|
-
|
|
80
|
-
工作流程使用以下环境变量:
|
|
81
|
-
|
|
82
|
-
- `GITHUB_TOKEN`:自动提供的 GitHub 令牌
|
|
83
|
-
- `NODE_VERSION`:Node.js 版本(默认为 20.x)
|
|
84
|
-
|
|
85
|
-
## 故障排除
|
|
86
|
-
|
|
87
|
-
### 构建失败
|
|
88
|
-
|
|
89
|
-
1. **检查 Node.js 版本**:确保使用支持的 Node.js 版本
|
|
90
|
-
2. **验证依赖安装**:确保 `npm ci` 成功执行
|
|
91
|
-
3. **检查构建输出**:查看 `zengen build` 的详细输出
|
|
92
|
-
4. **CLI 输出目录问题**:ZEN 现在强制输出到 `.zen/dist` 目录,不再支持 `--out` 参数。
|
|
93
|
-
|
|
94
|
-
### 部署失败
|
|
95
|
-
|
|
96
|
-
1. **检查权限**:确保工作流程有正确的 Pages 写入权限
|
|
97
|
-
2. **验证制品**:确保 `.zen/dist` 目录包含有效的 HTML 文件
|
|
98
|
-
3. **查看日志**:检查 GitHub Actions 日志获取详细错误信息
|
|
99
|
-
|
|
100
|
-
### 文档未更新
|
|
101
|
-
|
|
102
|
-
1. **检查触发条件**:确保修改了 `demo/src/` 目录下的文件
|
|
103
|
-
2. **等待部署完成**:GitHub Pages 部署可能需要几分钟
|
|
104
|
-
3. **清除浏览器缓存**:浏览器可能缓存了旧版本
|
|
105
|
-
|
|
106
|
-
## 手动触发
|
|
107
|
-
|
|
108
|
-
可以通过 GitHub Actions 界面手动触发部署:
|
|
109
|
-
|
|
110
|
-
1. 进入仓库的 "Actions" 标签页
|
|
111
|
-
2. 选择 "Deploy to GitHub Pages" 工作流程
|
|
112
|
-
3. 点击 "Run workflow" 按钮
|
|
113
|
-
4. 选择分支并运行
|
|
114
|
-
|
|
115
|
-
## 相关文件
|
|
116
|
-
|
|
117
|
-
- `demo/src/`:文档源文件(Markdown 格式)
|
|
118
|
-
- `package.json`:项目配置和依赖
|
|
119
|
-
- `src/cli.ts`:zengen CLI 工具实现
|
|
120
|
-
- `src/builder.ts`:文档构建器实现
|
package/.zen/src/zh-Hans/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md
DELETED
|
@@ -1,73 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: ZEN - Markdown 文档站点构建工具
|
|
3
|
-
summary: ZEN 是一个极简的 Markdown 静态站点生成工具,专注于内容写作,利用 AI 处理翻译和导航,支持多语言构建,无需复杂配置。
|
|
4
|
-
tags:
|
|
5
|
-
- Markdown
|
|
6
|
-
- 静态站点生成器
|
|
7
|
-
- AI 翻译
|
|
8
|
-
- 多语言
|
|
9
|
-
- 极简主义
|
|
10
|
-
- 文档工具
|
|
11
|
-
- ZEN
|
|
12
|
-
inferred_lang: 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` 目录。不支持指定源目录和输出目录参数。
|
package/.zen/src/zh-Hans/084ef1f6a0167df8621c673c79211309d4af6c588e7bbe3e043f7c244edd0ac6.md
DELETED
|
@@ -1,80 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: ZEN - Markdown 文档站点构建工具
|
|
3
|
-
summary: ZEN 是一个简洁的 Markdown 静态站点生成工具,专注于内容写作,利用 AI 实现智能导航和多语言翻译,无需复杂配置。
|
|
4
|
-
tags:
|
|
5
|
-
- Markdown
|
|
6
|
-
- 静态站点生成
|
|
7
|
-
- AI 翻译
|
|
8
|
-
- 多语言
|
|
9
|
-
- 极简主义
|
|
10
|
-
- 文档工具
|
|
11
|
-
- ZEN
|
|
12
|
-
inferred_lang: 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` 目录。不支持指定源目录和输出目录参数。
|