Skip to content

zccz14/CZON

Repository files navigation

CZON - AI-Native Markdown 内容引擎

> Website Demo

AI 时代下,作为网站内容创作者,我们可以有更智能的内容创作引擎。

回归内容:最小化打扰,专注写作

让文档回归本质,让写作回归宁静。

其一,我不想做图书管理员。我有时想写下一些内容,但我可能还没有想好它的标题,还没有形成特别的组织。我希望 LLM 会自动帮我生成标题、做摘要、分类、导航等整理工作。

其二,我的书房必须打扫干净。我不想要配置复杂的构建工具,折腾复杂的文档配置,不喜欢复杂的结构。每次我看到 Docusaurus、VuePress、Astro 这些工具的配置文件和项目结构,我就头疼。现在,CZON 选择将所有的配置都隐藏到 .czon 目录下,扫到角落里,用户只需要专注于写作内容,其他的交给 CZON 来处理。其他的目录都是您的写作空间,您可以随意组织您的 Markdown 文件。

回归母语:用母语写作,丝滑构建多语言版本

人生苦短,我懒得翻译。人在使用母语时,才是最能发挥自身思考深度的。但同时与世界保持连接又是必要的,我不想放弃多语言的交流。于是我希望有一个工具,能让我用母语写作,同时又能让更多人看到我的内容。现在的 i18n 需要自己翻译不说,还得自己维护内容更新,太麻烦了。我选择使用 LLM 来帮我做翻译,省下了我很多时间,并且可以一键完成多国语言翻译。

基本功能

  1. 🌍 自动多语言翻译:使用 AI 进行增量翻译,让用户使用母语编写 Markdown,但是用户可以是多语言的。
  2. 💭 自动摘要提取:使用 AI 对原始文本进行内容分析和提取。
  3. 🧭 智能分类导航:使用 AI 生成站点地图和导航,源文件的位置不敏感。

静态站点生成 (SSG)

CZON 内置了一个 SSG 方案,可以将任意一个包含 Markdown 的 git 文件夹构建成一个静态 HTML 站点。

⚠️ 请注意,CZON 不是专业的静态站点生成器(SSG),而是一个 AI 驱动的 Markdown 内容引擎,专注于内容创作和管理。

✅ CZON 旨在简化内容创作和发布的流程,让用户能够专注于写作本身,而不是被复杂的配置和工具所困扰。

❌ CZON 不会提供复杂的主题定制和插件生态,而是专注于通过 AI 提升内容的质量和可访问性。

🔔 但是,CZON 仍然可以生成静态站点,如果有必要的话,可以将 CZON 作为预处理器,集成其他 SSG 方案生成个性化的、美观的站点。

快速开始

前提:

  • 已安装 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 模型

构建站点,支持多语言翻译。使用当前目录作为源目录,输出到 .czon/dist 目录。

  • 可以通过多次使用 --lang 参数指定需要生成的语言版本(例如 --lang zh-Hans --lang en-US)。
  • 不需要配置源语言,CZON 会自动检测。
npx czon@latest build --lang zh-Hans --lang en-US

查看更多参数或帮助

npx czon@latest

About

AI-Native Markdown Content Engine

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •