美文网首页
[扩展推荐] LaRecipe: 在你的 Laravel 项目中

[扩展推荐] LaRecipe: 在你的 Laravel 项目中

作者: summerbluet | 来源:发表于2019-11-20 09:57 被阅读0次
    image

    文章转发自专业的Laravel开发者社区,原始链接:https://learnku.com/laravel/t/17310

    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 源代码仓库在这里 .

    相关文章

      网友评论

          本文标题:[扩展推荐] LaRecipe: 在你的 Laravel 项目中

          本文链接:https://www.haomeiwen.com/subject/kdgnictx.html