doczilla/doczilla

美观且速度极快的文档,由 Laravel、Livewire 和 Volt 构建。

该软件包的官方仓库似乎已消失,因此该软件包已被冻结。


README

Doczilla! Build Status Code Coverage Total Downloads Latest Stable Version License Laravel Forge Site Deployment Status

Doczilla 文档平台

等待我们的 wip 安装程序包,您可以根据以下说明进行设置。

本地开发

要开始,您需要在系统上安装 node 和 npm,当然还需要 composer。由于这是一个基于 Laravel 的平台,我们假设您将在 Valet 上进行本地开发。如果不是这样,您将知道如何克隆您的仓库。

  1. 分支此仓库
  2. 打开您的终端并 cd 到您的 ~/Sites 文件夹
  3. 通过运行以下命令将您的分支克隆到 ~/Sites/doczilla 文件夹中,将您的用户名放在 {username} 位置
    git clone git@github.com:{username}/doczilla.git doczilla
  4. CD 到您刚刚创建的新目录
    cd doczilla
  5. 运行位于 package.json 文件中的 setup 脚本,该脚本将执行所有必要的步骤来准备您的本地安装
    npm run setup
  6. 或者,您可以直接在 composer install 之后运行 docs:setup artisan 命令
composer install && php artisan docs:setup

同步上游更改到您的分支

GitHub 文章 提供了如何从该仓库拉取最新更改到您的分支的说明。

远程代码更改后的更新

如果您从该仓库将上游更改拉取到本地仓库,您将需要更新您的 Composer 和 NPM 依赖项,以及更新您的文档分支。为了方便起见,您可以运行 package.json 中的 update 脚本,该脚本别名为运行 artisan 的 docs:update 命令。

npm run update

或者,您可以直接运行更新 artisan 命令

php artisan docs:update