Laravel文档启动器

jigsaw-docs-template — Laravel 文档模板

作者 tighten

Tighten 出品的 Jigsaw 文档站启动模板,基于 Laravel 静态生成器,内置 Tailwind 与 DocSearch。

看看你的网站会是什么样

浏览真实页面截图,比较内容排版与手机效果。点击下方缩略图切换,放大查看整页细节。

3 个预览视图
桌面端首页1 / 3
桌面端截图

演示站首页的真实桌面布局。

全部页面与视图 3

截图用于了解视觉与布局,交互效果请以实际项目为准。 本截图因高度限制未包含整页。

采集于 2026-09-27查看来源

值得关注的模板亮点

从已有项目资料中,快速了解它的特点。

01

基于 Jigsaw(Laravel 静态生成器),输出纯静态文件

02

预置响应式导航、侧边栏、404 页面等文档站常见结构

03

集成 Tailwind CSS,可自定义设计而不必手写 CSS

04

内置 Prism.js 代码高亮

05

预留 Algolia DocSearch 搜索位,需自行申请服务

06

自动生成 sitemap.xml 的脚本

模板详细介绍

jigsaw-docs-template 是 Tighten 团队为 Jigsaw 静态站点生成器准备的文档站启动模板。Jigsaw 本身基于 Laravel,用 Blade 模板和 Markdown 编写内容,最终构建为纯静态 HTML。这个模板把文档站常见的结构都预先搭好:响应式导航栏、侧边栏菜单、自定义 404 页面,以及用 Prism.js 实现的代码高亮。样式方面直接集成了 Tailwind CSS,意味着你可以在不写一行 CSS 的情况下调整设计,前提是你熟悉 Tailwind 的 utility class 工作方式。

内容默认放在 source/docs 目录,每个页面通过 YAML 头指定标题、布局和所属区块,结构清晰,适合需要快速上线文档的产品团队。搜索功能预留了 Algolia DocSearch 的接入位,但需要你自己去申请免费的索引服务并填入配置,并非开箱即用。模板还附带了一个自动生成 sitemap.xml 的脚本,对 SEO 友好。

需要留意的是,这个模板只是启动器,不是完整成品。你必须先安装 Jigsaw 才能初始化,而且上线前要改 config.php 里的站点名称、描述和 baseUrl。README 没有详细说明部署到生产环境的步骤,也没有提供主题切换或多版本文档等高级功能,这些都需要你根据 Jigsaw 官方文档自行扩展。

Laravel文档启动器

适合你的项目吗?

适用场景

  • 为开源项目或产品快速搭建文档站
  • 需要静态生成的文档,便于托管在任意 CDN 或 GitHub Pages
  • 团队已熟悉 Laravel 或 Blade 模板,希望用 PHP 生态构建文档
  • 希望用 Tailwind 快速定制样式,且不引入复杂前端框架

适合人群

  • Laravel 开发者或 PHP 团队
  • 需要轻量级、无数据库的文档站点
  • 希望保持内容与代码分离,用 Markdown 编写文档
  • 对 SEO 有要求,需要自动生成 sitemap

上手与定制指南

结合仓库当前版本的说明,按下面的资料检查内容、配置与运行要求。

  1. 1

    先安装 Jigsaw,然后在项目目录运行 ./vendor/bin/jigsaw init docs。

  2. 2

    需要 Node.js 环境以使用 Vite 编译资源。

  3. 3

    编辑 config.php 中的 baseUrl、siteName、siteDescription 等变量,并配置 DocSearch 的 App ID、API Key 和 Index Name。

  4. 4

    内容文件需放在 source/docs,若修改路径需同步更新 navigation.php。

  5. 5

    开发时运行 npm run dev,构建静态文件用 npm run build。

查看仓库使用说明

授权与来源资料

使用条件与限制

免费使用 · 保留许可声明

MIT许可证允许免费使用、修改、分发和商用,仅需保留版权与许可声明。README未附加额外限制。

使用时需要遵守

  • 保留原作者版权声明和 MIT 许可证声明。
  • 在所有副本或实质部分中包含版权声明和许可声明

额外费用与待核对事项

  • README提及的Tailwind CSS、Prism.js、Algolia DocSearch等第三方组件许可未在提供文本中全文确认
查看原文依据

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

许可证原文

Permission is hereby granted, free of char

许可证原文
https://github.com/tighten/jigsaw-docs-template/blob/main/LICENSE.txthttps://github.com/tighten/jigsaw-docs-template/blob/HEAD/README.md

DeepSeek 根据仓库许可证和 README 整理 ·2026-09-24。结果仅覆盖已读取资料,依赖、图片、字体及后续条款变更以各自原文为准。

项目核对记录与介绍依据

模板资料

来源平台
GitHub
资料与维护参考分
资料较完整 · 86 / 100
技术栈
Laravel
网站类型
文档 · 启动器
这个分数如何计算

本站按许可资料(最高30分)、演示链接(12分)、预览图(10分)、Star数(15分)、记录的维护时间(15分)、描述完整度(8分)、功能记录(5分)和分类资料(5分)计算。它不是代码、安全或性能测试,也不是 Google 评分;有链接不代表已实测可用。

这个项目需要核对什么

记录的仓库更新时间
2026-08-11
截图检查日期
2026-09-03

已收录演示链接。请用你的内容与屏幕尺寸检查;有演示不代表表单、认证或支付已经可用。

目录记录的主要技术栈是 Laravel。请通过依赖清单和锁文件核对实际版本与托管要求。这些说明基于收录资料,不代表代码审计或部署实测。

查看具体选型方法 →

介绍的制作与核对状态

介绍由 AI 辅助整理目录与仓库资料。仓库作者不等于这篇介绍的审核者。

当前版本没有可核对的编辑审核记录;旧的应用时间不代表已完成事实审核。

这条历史介绍未保存固定版本的来源快照。请对照当前仓库,发现不一致可反馈。

反馈内容错误

看看同类模板

对比同技术栈与用途的模板,找到更适合的视觉与内容结构。