Laravel 生成精美的项目使用文档扩展 overtrue / wisteria

overtrue/wisteria 扩展可以将Markdown格式文章生成精美的项目使用文档网站，方便用户查看。

扩展GitHub地址

https://github.com/overtrue/wisteria

生成的文档效果

安装

$ composer require overtrue/wisteria -vvv

使用

发布配置和所需资源

$ php artisan wisteria:install

运行上述命令会创建wisteria的配置文件 config/wisteria.php, 并且将文档展示用的静态资源文件复制到 public/vendor/wisteria 目录下。

更新配置文件，并根据配置创建markdown格式的项目文档

config/wisteria.php 配置文件说明

具体使用参考 EasyWeChat 文档

https://github.com/easywechat/docs

 '/topic', # 项目文档访问路由

    'middlewares' => [],

    'docs' => [
        // Storage path of docs files.
        'path' => '/storage/app/topic', # 项目的Markdown格式文档存储路径

        // Index page file.
        'index' => 'index.md', # 文档目录文件，

        // Homepage
        'home' => 'overview.md', # 文档首页

        // Versions
        'versions' => [ # 可以设置多个文档版本共存，如你项目升级，每个版本对应的文档不同
        ],
        'default_version' => '', # 默认打开的文档版本

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

    // UI settings
    'ui' => [
        'logo' => 'images/topic_logo.png', # 125 * 30 项目logo
        'nav-links' => [ # 文档顶部导航栏
            [
                'url' => '/',
                'label' => '首页',
                'target' => '_self',
            ]
        ],
    ],

    // SEO configs
    'seo' => [
        'author' => '木偶',
        'description' => '木偶SEO站点专题文章',
        'keywords' => '木偶SEO',
        'og' => [
            'title' => '木偶SEO站点专题文章',
            'type' => 'article',
            'url' => '',
            'image' => '',
            'description' => '木偶SEO站点专题文章',
        ],
    ],

    '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
    ],
];

根据上述配置文件，将自己的项目文档每个markdown文件放在文档版本文件夹下，编辑好index.md文件作为目录

初始化文档

创建好文档后执行以下命令使文档生效

$ php artisan wisteria:refresh

访问文档

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

————————————————
本文由木偶笔记发表于 2021-11-07
转载请务必保留本文链接：https://www.muouseo.com/article/m0wekxvp9k.html