[扩展推荐] LaRecipe: 在你的 Laravel 项目中添加 Markdown 文档功能

file

LaRecipe 是由 Saleem Hadad 创建的一个扩展包,它提供了一种在 Laravel 应用程序内使用 Markdown 语法为你的产品或应用程序创建精美文档的简便方法。

要开始使用它,需要通过 composer 安装并运行安装命令以发布必要的文件和配置:

php artisan larecipe:install

开箱即用,LaRecipe 会将你的文档置于 /docs URL 下,你可以在应用旁边对文档进行版本控制。典型的安装目录结构如下:

├─ config
│  └─ larecipe.php
└─ resources
   └─ docs
      │─ 1.0
      │  │─ index.md
      │  └─ overview.md
      └─ 2.0
         │─ index.md
         └─ overview.md

上例中具有 /docs/1.0 到 /docs/2.0的路由。你可以自定义基础路由,文档文件位置,以及登录页。例如,将 landing 配置项设置为  overview 会把登录页指向 overview.md

你可以按照如下配置去设置和控制文档的默认以及发布版本:

return [
    'versions'      => [
        'default'   => '1.0',
        'published' => [
            '1.0'
        ]
    ]
];

你也能从 配置文档 和 PHP 配置文件 中了解到更多的 LaRecipe 配置项.

LaRecipe 将你的 markdown 文档转换成 HTML, 同时也支持可选的 Vue 组件. 你可以从 Vue 支持组件 文档中了解更多. 同时它还包含一些开箱即用的 Vue 组件,例如卡片、按钮、徽章以及进度条等.

你可以通过阅读 LaRecipe 文档 来开始 LaRecipe . 它的 GitHub 源代码仓库在这里 .

本文中的所有译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。

原文地址:https://laravel-news.com/larecipe-docume...

译文地址:https://learnku.com/laravel/t/17310

本帖已被设为精华帖!
本文为协同翻译文章,如您发现瑕疵请点击「改进」按钮提交优化建议
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
讨论数量: 5
Summer

@wilson_yang fixed

5年前 评论
oyghan

本社区的文档模块用也是这个插件吗?@Summer

5年前 评论
Summer

@oyghan 不是,自己手写的

5年前 评论

@Summer 您好 我想问一下. 我的laravel 已经部署好了 LaRecipe ,请问如何自动生存api接口文档?

2年前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!