前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >牛逼!一个用于创建文档的PHP插件

牛逼!一个用于创建文档的PHP插件

作者头像
老鱼的日常
发布2023-08-25 10:52:05
1970
发布2023-08-25 10:52:05
举报
文章被收录于专栏:程序员老鱼呀
LaRecipe 帮助您使用 Markdown 为您的软件项目编写干净、漂亮的文档,并将文档保留在源代码中。
安装使用
代码语言:javascript
复制
composer require binarytorch/larecipe

php artisan larecipe:install

然后通过yourdomain.test/docs访问或者通过http://127.0.0.1:8000/docs本地访问。

配置

安装 LaRecipe 后,配置文件位于config/larecipe.php. 在此文件中,你可以找到用于更改 LaRecipe 安装配置的各种选项。

比如陆页面用于在用户访问您的文档根路由而不指定页面时将其重定向到该页面,默认情况下假定为overview.md.

代码语言:javascript
复制
return [
    'docs'      => [
        'route'   => '/docs',
        'path'    => '/resources/docs',
        'landing' => 'overview',
        'middleware' => ['web']
    ]
];

设置版本,指定用户可以查看的文档的已发布版本

代码语言:javascript
复制
return [
    'versions'      => [
        'default'   => '1.0',
        'published' => [
            '1.0'
        ]
    ]
];

设置缓存

代码语言:javascript
复制
return [
    'cache'       => [
        'enabled' => false,
        'period'  => 5
    ]
];
VUE组件

LaRecipe 在 Laravel 应用程序的后端呈现文档,因此利用自定义 VueJs 组件非常酷。

LaRecipe 提供了一堆令人惊叹的基于 UI Vue 的组件。

代码语言:javascript
复制
<larecipe-card shadow>
   Example card
</larecipe-card>
代码语言:javascript
复制
<larecipe-button radius="full">Example button</larecipe-button>
<larecipe-button type="success" radius="full">Success button</larecipe-button>

还有更多特性功能大家自行探索噢~

Github地址:https://github.com/saleem-hadad/larecipe

LaRecipe 包内部使用了一些开源的第三方库/包

  • Laravel - 开源全栈框架。
  • VueJs - 渐进式 JavaScript 框架。
  • TailwindCSS - 用于快速 UI 开发的实用程序优先的 CSS 框架。
  • erusev/parsedown-extra - PHP markdown 解析器。
  • symfony/dom-crawler - Dom 操作。
  • phpunit/phpunit - PHP 单元测试库。
  • Orchestra/testbench - Laravel 包的单元测试包。

End

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2023-08-23,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 老鱼的日常 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 安装使用
  • 配置
  • VUE组件
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档