讲师中心 微信公众号
AI工具推荐 视频效率加速

Laravel文档完善跨平台部署:将生成的静态文档托管到GitHub Pages【指南】

千宇吖_1371

千宇吖_1371

发布时间:2026-06-01 20:42:35

|

917人浏览过

|

来源于php中文网

原创

可直接部署Scribe或L5-Swagger生成的静态HTML文档到GitHub Pages,需确保public/docs(Scribe)或public/swagger(L5-Swagger)目录为纯静态资源,并正确配置Pages源为根目录或gh-pages分支,同时设置CNAME和HTTPS。

laravel文档完善跨平台部署:将生成的静态文档托管到github pages【指南】

直接把 Laravel 项目生成的静态文档(比如用 Scribe 或 L5-Swagger 导出的 HTML)部署到 GitHub Pages,是轻量、免费且可长期维护的方案。关键不在“能不能”,而在路径配置、构建产物位置和 Pages 源设置是否匹配。

确认文档已导出为纯静态文件

以 Scribe 为例,运行 php artisan scribe:generate 后,默认输出在 public/docs 目录下,里面是完整的 HTML/CSS/JS 文件,无需服务器支持。L5-Swagger 则通常输出到 public/swagger 或自定义路径。确保该目录存在且能本地打开 index.html 正常访问。

  • 检查 public/docs/index.html 是否可双击打开并显示完整交互式文档
  • 若使用 VuePress/Hugo 等生成器,需先执行 npm run build 或 hugo,产出物一般在 dist/ 或 docs/.vuepress/dist
  • 避免将 storage、vendor 或 PHP 文件混入部署目录——GitHub Pages 只认静态资源

选择合适的仓库与部署方式

两种主流方式,按用途选:

YiHui GITHUB MONITOR
YiHui GITHUB MONITOR

监控多个 GitHub 仓库,配置发布、PR 与安全告警策略,通过定时 cron 任务推送低噪声通知。

下载
  • 用户主页形式:建一个 yourname.github.io 仓库,把文档整个放进去(如 public/docs 内容直接放在仓库根目录),发布后地址为 https://yourname.github.io/。适合个人主站或核心项目文档入口
  • 项目子路径形式:在现有 Laravel 项目仓库中启用 Pages,Source 设为 gh-pages 分支或 /docs 目录。文档访问地址为 https://yourname.github.io/your-laravel-project/,更利于代码与文档同仓管理

配置 Pages 源并处理路径问题

GitHub Pages 默认从所选分支的根目录找 index.html。但 Scribe 导出的文档在 /docs 子目录,直接放根目录会 404。解决方法有两个:

  • 把 public/docs 全部内容复制到仓库根目录(覆盖掉默认的 index.html),适合用户页部署
  • 改用 GitHub Actions 自动化部署:在 .github/workflows/deploy-docs.yml 中指定构建后将 public/docs 推送到 gh-pages 分支,Pages 源设为该分支即可
  • 若用前端框架(如 VuePress)生成文档,必须在配置中设好 base: "/your-repo-name/",否则资源路径会 404

绑定域名与 HTTPS 设置

GitHub Pages 默认启用 HTTPS,无需额外操作。要绑定自定义域名:

  • 在仓库根目录新建 CNAME 文件,内容只写一行:例如 docs.yourapp.com
  • 去你的 DNS 服务商添加一条 CNAME 记录:docs → yourname.github.io
  • 等 DNS 生效(通常几分钟到几小时),GitHub 页面设置里会出现绿色锁图标,表示 HTTPS 已就绪

不复杂但容易忽略。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

857

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

835

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2488

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

4201

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

6030

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

3996

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

7509

2025.08.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

1456

2026.03.04

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

80

2026.10.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 208人学习

Composer手册
Composer手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn