ohseesoftware/laravel-markdown-content

Laravel Markdown Content 是一个有观点的包,旨在使向您的网站添加由 Markdown 生成的页面变得轻而易举。它遵循相同的思想,并深受 Laravel Pages 的启发。

v1.1.0 2022-01-30 18:25 UTC

This package is auto-updated.

Last update: 2024-08-29 05:37:39 UTC


README

Current Release Build Status Badge Downloads MIT License

概览

Laravel Markdown Content 是一个有观点的包,旨在使向您的网站添加由 Markdown 生成的页面变得轻而易举。它遵循相同的思想,并深受 Laravel Pages 的启发。

开箱即用,Laravel Markdown Content 支持以下用例

  • 渲染单个文章
  • 渲染文章列表
  • 渲染单个分类

文章可以是任何类型的内容,而不仅仅是“帖子”。

内容

  • Markdown 内容通过 Commonmark 进行解析和渲染成 HTML,允许您传递额外的插件
  • 然后,该包将渲染您选择的 Blade 视图,传入 Markdown 内容的 HTML 版本

安装

使用 composer 安装该包

composer require ohseesoftware/laravel-markdown-content

发布配置文件

php artisan vendor:publish --tag=markdown-content-config

配置文件允许您定义

  • 用于渲染内容的自定义 Commonmark 扩展
  • 用于提供的路由逻辑的路由定义

注意:该包不提供默认视图来渲染内容,因此您必须提供自己的视图并将其添加到配置文件中。

可维护性评分

  • 如果您想报告代码可维护性,请在 https://codeclimate.com 设置 repo
  • 更新此 README 文件中的 Code Climate 图片 URL

编写文档

  • 删除此 TODO 部分,并用您的包的文档替换!

变更日志

请参阅 CHANGELOG 了解最近有哪些更改。

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全

如果您发现任何与安全相关的问题,请通过电子邮件 security@ohseesoftware.com 而不是使用问题跟踪器。

鸣谢

许可协议

MIT 许可协议 (MIT)。有关更多信息,请参阅 许可文件

Laravel Package Boilerplate

此包是使用 Laravel Package Boilerplate 生成的。