zengen
v0.3.2
Published
ZEN - A minimalist Markdown documentation site builder
Downloads
1,920
Maintainers
Readme
ZEN - 极简主义 Markdown + AI 静态站点构建器
基本功能
- 📃 静态站点生成:将任意一个包含 Markdown 的 git 文件夹构建成一个静态 HTML 站点。
- 🧭 智能分类导航:使用 AI 进行内容分析,生成站点地图和导航,源文件的位置不敏感。
- 🌍 自动增量翻译:使用 AI 进行增量翻译,让用户使用母语编写 Markdown,但是用户可以是多语言的。
为什么又搞了个 Markdown 静态站点生成器?我重新思考了 AI 时代下,文档工具可以如何更好地服务于写作者:
回归内容:最小化打扰,专注写作
让文档回归本质,让写作回归宁静。
其一,我不想做图书管理员。我有时想写下一些内容,但我可能还没有想好它的标题,还没有形成特别的组织。我希望 LLM 会自动帮我生成标题、做摘要、分类、导航等整理工作。
其二,我的书房必须打扫干净。我不想要配置复杂的构建工具,折腾复杂的文档配置,不喜欢复杂的结构。每次我看到 Docusaurus、VuePress、Astro 这些工具的配置文件和项目结构,我就头疼。现在,ZEN 选择将所有的配置都隐藏到 .zen 目录下,扫到角落里,用户只需要专注于写作内容,其他的交给 ZEN 来处理。其他的目录都是您的写作空间,您可以随意组织您的 Markdown 文件。
回归母语:用母语写作,丝滑构建多语言版本
人生苦短,我懒得翻译。人在使用母语时,才是最能发挥自身思考深度的。但同时与世界保持连接又是必要的,我不想放弃多语言的交流。于是我希望有一个工具,能让我用母语写作,同时又能让更多人看到我的内容。现在的 i18n 需要自己翻译不说,还得自己维护内容更新,太麻烦了。我选择使用 LLM 来帮我做翻译,省下了我很多时间,并且可以一键完成多国语言翻译。
快速开始
前提:
- 已安装 Node.js(建议版本 18 及以上,需要有 npx 命令)
- 已获取 OpenAI API Key,或者 OPENAI 兼容的 API Key
- 已安装 Git(用于从 Git 列出 Markdown 文件,忽略 .gitignore 规则过滤的文件)
首先,工作在一个已经被 git 管理的文件夹中:
配置环境变量
export OPENAI_API_KEY="sk-xxxxxx" # 必须:请替换为您的 OpenAI API Key
export OPENAI_BASE_URL="https://api.openai.com/v1" # 可选,默认使用 OpenAI 官方 API
export OPENAI_MODEL="gpt-3.5-turbo" # 可选,默认使用 gpt-3.5-turbo 模型构建站点,支持多语言翻译。使用当前目录作为源目录,输出到 .zen/dist 目录。
- 可以通过多次使用
--lang参数指定需要生成的语言版本(例如--lang zh-Hans --lang en-US)。 - 不需要配置源语言,ZEN 会自动检测。
npx zengen@latest build --lang zh-Hans --lang en-US查看更多参数或帮助:
npx zengen@latest