[擴展推薦] LaRecipe: 在你的 Laravel 項目中添加 Markdown 文檔功能

文章轉發自專業的Laravel開發者社區，原始連接：learnku.com/laravel/t/1…

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 源代碼倉庫在這裏 .