README

Ladoc 允许您搜索和浏览所有版本的 Laravel 文档。

安装

使用 Composer

需要 PHP 8.2

composer global require "millancore/ladoc"

或使用 Docker

 docker run -td --name ladoc millancore/ladoc

使用

docker exec -it ladoc sh # (and then zz or ladoc)

用法

提示：为了便于使用，可以创建别名，我通常使用 zz。

搜索

ladoc <section> <query>

ladoc blade @once

列出所有部分

直接执行命令不带参数，您将看到所有部分（括号内）的列表。

ladoc

结果

 Main List

• [0] Artisan Console (artisan)
• [1] Authentication (authentication)
• [2] Authorization (authorization)
• [3] Laravel Cashier (Stripe) (billing)
• [4] Blade Templates (blade)
...

过滤主列表

为了简化导航，可以使用 '--letter' 或 -l 和首字母来过滤主列表。

ladoc -lv

结果

 Main List | filter: V

• [0] Validation (validation)
• [1] Views (views)

导航系统

您可以使用列表中的索引来遍历所有部分。

ladoc 4

结果

 Blade Templates

• [0] Introduction (+)
• [1] Displaying Data (+)
• [2] Blade Directives (+)
...

然后继续这种方式

ladoc 4 2

结果

Blade Directives

In addition to template inheritance and displaying data...

────────────────────────
• [0] If Statements
• [1] Switch Statements
• [2] Loops
• [3] The Loop Variable
...

使用索引进行搜索

您可以直接使用部分的索引来搜索。例如，ladoc 4 @once 等同于 ladoc blade @once。

版本

Ladoc 允许您搜索 Laravel 的所有版本，只需使用 --branch 或 -b 来定义您想要使用的版本。

ladoc -b5.2 blade

如果没有设置版本，将使用最新版本。

Ladoc 是一个开源软件，采用 MIT 许可。

millancore / ladoc

维护者

详细信息