MkDocs

一个由 FumaPress 驱动并部署在 Cloudflare Workers 上的快速文档模板。

在线演示 · 文档 · 报告 Bug

 ## 功能 - 内容优先的文档，支持 Markdown 和 MDX - 支持键盘快捷键的静态搜索 - 响应式导航、目录以及浅色/深色/系统主题 - 支持本地化的路由以及可自定义的语言切换器 - 可复用的卡片、提示框、步骤、标签页、折叠面板、文件树、类型表、Lucide 图标和视频嵌入 - 每页独立的 Markdown、`llms.txt`、全项目通用的 Open Graph 图片以及站点地图生成 - 使用 Wrangler 静态部署到 Cloudflare Workers - 无需 Worker 运行时代码或应用绑定 ## 技术栈 - [FumaPress](https://press.fumadocs.dev) 和 [Fumadocs](https://fumadocs.dev) - [Waku](https://waku.gg) 和 React - TypeScript 和 Tailwind CSS - [Cloudflare Workers 静态资源](https://developers.cloudflare.com/workers/static-assets/) ## 快速开始 ### 前置条件 - Node.js 20.19 或更高版本 - [pnpm](https://pnpm.io) ### 安装 ``` git clone https://github.com/open-fox/mkdocs.git cd mkdocs pnpm install pnpm dev ``` 打开终端中输出的本地 URL。 ### 命令 | 命令 | 描述 | | --- | --- | | `pnpm dev` | 启动本地开发服务器 | | `pnpm build` | 生成可用于生产的静态站点 | | `pnpm check` | 运行源码生成、TypeScript、构建和 Wrangler 模拟运行检查 | | `pnpm deploy` | 使用 Wrangler 构建并部署站点 | ## 部署到 Cloudflare Workers 1. 验证 Wrangler： pnpm exec wrangler login 2. 在 `wrangler.jsonc` 中更新 Worker 名称和可选的自定义域名。 3. 验证并部署： pnpm check pnpm deploy 对于 CI 部署，请将 `CLOUDFLARE_API_TOKEN` 和 `CLOUDFLARE_ACCOUNT_ID` 作为密钥提供。 ## 作者 [OpenFox](https://mksaas.link/fox-x) 是一名独立开发者，致力于开发产品和开发者工具。他的产品包括： - [TanStarter](https://tanstarter.dev) — 使用 TanStack 加速交付，使用 Cloudflare 降低成本。 - [MkSaaS](https://mksaas.com) — 在一个周末完成你的 AI SaaS 产品。 - [MkImage](https://mkimage.ai) — 让任何图像成为可能。 - [MkDirs](https://mkdirs.com) — 在 30 分钟内上线 AI 驱动的目录网站。 - [MkDollar](https://mkdollar.com) — 帮助你在网上赚取第一桶金的一体化平台。 ## 许可证 基于 [MIT License](./LICENSE) 授权。

标签：Fumadocs, React, Syscalls, TypeScript, 前端模板, 安全插件, 文档系统, 程序员工具, 自动化攻击, 高对比度