juicydocs-11ty-starter
Eleventy / 工具站 · 文档 · 启动器 · 作者 freshjuice-dev
基于 Eleventy v3 与 Tailwind CSS v4 的文档站启动器，内置 Pagefind 搜索、Shiki 高亮与 llms.txt。
使用许可与条件
免费使用 · 保留许可声明
MIT许可，允许免费使用、修改、商用与再分发，仅需保留版权与许可声明；示例图片来自Pexels标注可免费使用。
使用时需要遵守
- 保留原作者版权声明和 MIT 许可证声明。
- 保留版权声明与许可声明于所有副本或实质部分
需要另行核对
- README未逐一确认所有第三方字体、图标的具体许可条款
查看原文依据
Permission is hereby granted, free of charge, to any person obtaining a copy
许可证原文
The above copyright notice and this permission notice shall be included in all
许可证原文
Sample images from [Pexels](https://www.pexels.com/) (free to use)
README 原文
https://github.com/freshjuice-dev/juicydocs-11ty-starter/blob/main/LICENSEhttps://github.com/freshjuice-dev/juicydocs-11ty-starter/blob/HEAD/README.mdPermission is hereby granted, free of char
许可证原文
DeepSeek 根据仓库许可证和 README 整理 · 2026-09-24。结果仅覆盖已读取资料，依赖、图片、字体及后续条款变更以各自原文为准。
模板详细介绍
JuicyDocs 是一个面向技术文档的静态站启动器，用 Eleventy v3 生成页面、Tailwind CSS v4 负责样式，并自带明暗两套主题。内容以 Markdown 存放在 src/content/docs/，通过 front matter 里的 eleventyNavigation 字段控制层级与排序，导航和站点元信息分别集中在 navigation.yaml 与 metadata.yaml 中维护，配置模块按 collections、filters、plugins、shortcodes、transforms 拆分在 config/ 目录下。
比较有辨识度的是它把文档站常见的几件事都预置好了：Pagefind 提供命令面板式搜索，Shiki 负责代码高亮，table-saw 让表格在移动端自动换行，lite-youtube-embed 延迟加载 YouTube 视频，另外还输出 sitemap、RSS、Open Graph 和 Twitter Cards，并生成 llms.txt 供 AI 读取。写作侧提供 alert、youtube、embed 三类 Nunjucks shortcode，适合想快速搭起产品文档、API 手册或开源项目说明站的人。
门槛主要在环境：README 要求 Node.js 24 及以上，构建产物是 _site/ 下的纯静态文件，可放到 Netlify、Cloudflare Pages、Vercel 或 GitHub Pages，其中 Netlify 已附带 _redirects 和 _headers。需要留意的是仓库标注的许可证状态为待核实，README 中写的是 MIT，正式使用前建议核对 LICENSE 文件；另外模板本身不含后端、登录或数据接口，搜索为静态索引方案，具体表现需在自己的内容规模下实测。
主要特点
- Eleventy v3 静态生成，输出 _site/ 目录可直接托管
- Tailwind CSS v4 样式，内置明暗主题与响应式布局
- Pagefind 命令面板搜索，无需外部搜索服务
- Shiki 代码高亮，配合 table-saw 处理移动端表格
- 预置 sitemap、RSS、Open Graph、Twitter Cards 与 llms.txt
- 提供 alert、youtube、embed 三类 Nunjucks shortcode
适用场景
- 为开源项目或 SaaS 产品搭建独立文档站
- 整理 API 手册、使用指南等以 Markdown 为主的内容
- 需要静态搜索与代码高亮、又不想引入后端的技术文档
- 部署到 Netlify、Cloudflare Pages 等静态托管平台
适合人群
- 熟悉 Markdown 与 Nunjucks 模板语法的开发者
- 使用 Node.js 24 及以上版本、能运行 npm 脚本的团队
- 偏好静态站点、希望自行掌控内容目录结构的项目
使用前需要核对
- 需要 Node.js 24+，版本约束见仓库 .nvmrc
- 克隆后执行 npm install，开发用 npm run dev（localhost:8080），构建用 npm run build
- 生产构建可加 ELEVENTY_ENV=production 以启用压缩
- 站点信息改 src/_data/metadata.yaml，导航改 src/_data/navigation.yaml
- 文档写在 src/content/docs/，front matter 用 eleventyNavigation 控制层级与排序
本介绍由 AI 根据目录元数据和仓库 README 整理，实际功能以原仓库为准。