MallokMallok

Docs从这里开始

从空目录到上线的网站。

下面的快速上手是精简版。完整文档放在 GitHub 仓库里,和它描述的代码在一起;这一页是导览。

01快速上手

五步,其中一步只是一条命令。

需要 Node.js 22 或更新版本(含 npm),以及一个能使用 Workers、D1 和 R2 的 Cloudflare 账号。以下步骤针对已发布的 0.1.0-rc.10 候选版。

  1. 在本地生成并检查项目

    这一步安装依赖、构建项目并检查部署配置,不会创建任何云资源。

    npx mallok create my-site --no-deploy
    cd my-site
  2. 登录 Cloudflare 并部署

    先确认 whoami 显示的是你要用的账号。创建过程会在该账号里开通一个 Worker、一个 D1 数据库和一个 R2 存储桶。想在首次部署时就绑定自己的域名,加上 --domain site.example.com。

    npx wrangler login
    npx wrangler whoami
    npx mallok create . --slug my-site

    已经登录,想一步到位?npx mallok create my-site 会一次完成生成、校验和部署。

  3. 在浏览器里完成初始化

    打开 CLI 输出的初始化地址,填入一次性的 setup key。向导会创建管理员、设置站点名称和语言,并可导入示例内容——示例只是占位,正式对外之前请替换成你自己的内容。

  4. 绑定自定义域名

    边缘缓存需要自定义域名;workers.dev 地址只用于预览。想让修改及时生效,还要把清缓存令牌(Zone → Cache Purge → Purge)和 zone id 配成 Worker secrets。没有它们,访客要等缓存过期才能看到新内容。

  5. 发布内容

    在 /_mallok/app 后台修改示例产品或新建内容,然后发布,不需要重新构建。也可以在终端或 CI 里,用分权限的 API 令牌直接发布整个内容包目录:

    npx mallok publish ./content

正式依赖之前: 目前是候选版。还没有“Deploy to Cloudflare”按钮,真实询盘邮件送达也尚未完成端到端验收。 查看发布状态

02文档导览

接下来读什么。

下面的链接都会打开 GitHub 上的文档。英文是主要文档语言;入门指南和发布状态有中文翻译,其余技术参考暂为英文。

03其他入口

看效果,读源码,装起来。

在线演示

只读的 Atelier 站点。示例企业与内容均为虚构;演示站不开放后台,也不收集询盘。

demo.mallok.dev

GitHub

源码、issue、更新日志和文档本身,采用 Apache-2.0 许可。

fobstack/mallok

一条命令,部署到你自己的账号。

Mallok 会在你自己的 Cloudflare 账号里创建 Worker、D1 数据库和 R2 存储桶,并把网站部署上去。Mallok 不托管任何东西,也不需要注册 Mallok 账号。

npx mallok create my-site

需要 Node.js 22 及以上,并先执行 wrangler login。加上 --no-deploy 只在本地生成并检查项目,不创建云资源。当前为 0.1 候选版。