Laravel 生成精美的項(xiàng)目使用文檔擴(kuò)展 overtrue / wisteria

overtrue/wisteria 擴(kuò)展可以將Markdown格式文章生成精美的項(xiàng)目使用文檔網(wǎng)站膏斤,方便用戶查看。

擴(kuò)展GitHub地址

https://github.com/overtrue/wisteria

生成的文檔效果

安裝

$ composer require overtrue/wisteria -vvv

使用

發(fā)布配置和所需資源

$ php artisan wisteria:install

運(yùn)行上述命令會(huì)創(chuàng)建wisteria的配置文件 config/wisteria.php, 并且將文檔展示用的靜態(tài)資源文件復(fù)制到 public/vendor/wisteria 目錄下义起。

更新配置文件,并根據(jù)配置創(chuàng)建markdown格式的項(xiàng)目文檔

config/wisteria.php 配置文件說(shuō)明

具體使用參考 EasyWeChat 文檔

https://github.com/easywechat/docs

<?php

return [
    'route' => '/topic', # 項(xiàng)目文檔訪問(wèn)路由

    'middlewares' => [],

    'docs' => [
        // Storage path of docs files.
        'path' => '/storage/app/topic', # 項(xiàng)目的Markdown格式文檔存儲(chǔ)路徑

        // Index page file.
        'index' => 'index.md', # 文檔目錄文件褂删,

        // Homepage
        'home' => 'overview.md', # 文檔首頁(yè)

        // Versions
        'versions' => [ # 可以設(shè)置多個(gè)文檔版本共存坏挠,如你項(xiàng)目升級(jí)奈懒,每個(gè)版本對(duì)應(yīng)的文檔不同
        ],
        'default_version' => '', # 默認(rèn)打開的文檔版本

        // Docs repository
        'repository' => [
            //'provider' => 'github',
            //'url' => 'https://github.com/overtrue/wisteria',
        ],
    ],

    // UI settings
    'ui' => [
        'logo' => 'images/topic_logo.png', # 125 * 30 項(xiàng)目logo
        'nav-links' => [ # 文檔頂部導(dǎo)航欄
            [
                'url' => '/',
                'label' => '首頁(yè)',
                'target' => '_self',
            ]
        ],
    ],

    // SEO configs
    'seo' => [
        'author' => '木偶',
        'description' => '木偶SEO站點(diǎn)專題文章',
        'keywords' => '木偶SEO',
        'og' => [
            'title' => '木偶SEO站點(diǎn)專題文章',
            'type' => 'article',
            'url' => '',
            'image' => '',
            'description' => '木偶SEO站點(diǎn)專題文章',
        ],
    ],

    'plugins' => [
        'google-analytics' => [
            // 'id' => 'UA-XXXXXXXX-1'
        ],

        // Algolia Docsearch
        'docsearch' => [
            //'api_key' => '',
            //'index_name' => '',
            //'placeholder' => 'Search',
        ],
    ],


    'date' => [
        'format' => 'Y-m-d H:i:s',
        'timezone' => 'UTC',
    ],


    'cache' => [
        'ttl' => 300, // seconds
    ],
];

根據(jù)上述配置文件奠涌,將自己的項(xiàng)目文檔每個(gè)markdown文件放在文檔版本文件夾下,編輯好index.md文件作為目錄

初始化文檔

創(chuàng)建好文檔后執(zhí)行以下命令使文檔生效

$ php artisan wisteria:refresh

訪問(wèn)文檔

http://{domain}/topic/{version}

————————————————
本文由木偶筆記發(fā)表于 2021-11-07
轉(zhuǎn)載請(qǐng)務(wù)必保留本文鏈接:https://www.muouseo.com/article/m0wekxvp9k.html

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末磷杏,一起剝皮案震驚了整個(gè)濱河市溜畅,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌极祸,老刑警劉巖慈格,帶你破解...
    沈念sama閱讀 222,378評(píng)論 6 516
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異遥金,居然都是意外死亡浴捆,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,970評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門稿械,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)选泻,“玉大人,你說(shuō)我怎么就攤上這事美莫∫趁校” “怎么了?”我有些...
    開封第一講書人閱讀 168,983評(píng)論 0 362
  • 文/不壞的土叔 我叫張陵厢呵,是天一觀的道長(zhǎng)窝撵。 經(jīng)常有香客問(wèn)我,道長(zhǎng)襟铭,這世上最難降的妖魔是什么碌奉? 我笑而不...
    開封第一講書人閱讀 59,938評(píng)論 1 299
  • 正文 為了忘掉前任短曾,我火速辦了婚禮,結(jié)果婚禮上道批,老公的妹妹穿的比我還像新娘错英。我一直安慰自己,他們只是感情好隆豹,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,955評(píng)論 6 398
  • 文/花漫 我一把揭開白布椭岩。 她就那樣靜靜地躺著,像睡著了一般璃赡。 火紅的嫁衣襯著肌膚如雪判哥。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,549評(píng)論 1 312
  • 那天碉考,我揣著相機(jī)與錄音塌计,去河邊找鬼。 笑死侯谁,一個(gè)胖子當(dāng)著我的面吹牛锌仅,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播墙贱,決...
    沈念sama閱讀 41,063評(píng)論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼热芹,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了惨撇?” 一聲冷哼從身側(cè)響起伊脓,我...
    開封第一講書人閱讀 39,991評(píng)論 0 277
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎魁衙,沒(méi)想到半個(gè)月后报腔,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,522評(píng)論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡剖淀,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,604評(píng)論 3 342
  • 正文 我和宋清朗相戀三年纯蛾,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片纵隔。...
    茶點(diǎn)故事閱讀 40,742評(píng)論 1 353
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡茅撞,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出巨朦,到底是詐尸還是另有隱情米丘,我是刑警寧澤,帶...
    沈念sama閱讀 36,413評(píng)論 5 351
  • 正文 年R本政府宣布糊啡,位于F島的核電站拄查,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏棚蓄。R本人自食惡果不足惜堕扶,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,094評(píng)論 3 335
  • 文/蒙蒙 一碍脏、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧稍算,春花似錦典尾、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,572評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至科平,卻和暖如春褥紫,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背瞪慧。 一陣腳步聲響...
    開封第一講書人閱讀 33,671評(píng)論 1 274
  • 我被黑心中介騙來(lái)泰國(guó)打工髓考, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人弃酌。 一個(gè)月前我還...
    沈念sama閱讀 49,159評(píng)論 3 378
  • 正文 我出身青樓氨菇,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親妓湘。 傳聞我的和親對(duì)象是個(gè)殘疾皇子查蓉,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,747評(píng)論 2 361

推薦閱讀更多精彩內(nèi)容