[扩展推荐] GitDown —— 支持 GitHub Markdown 语法的 PHP Markdown 解析器

file

GitDown 是 Caleb Porzio 编写的一个简单的包,用于在PHP中解析(GitHub Flavored)Markdown。它的工作原理就是把 markdown 发送到一个公共的 GitHub API 然后解析成 HTML。

如果你使用的不是 Laravel, 你也可以使用它。以下是在一个 Laravel 项目中使用它的基本方式:

GitDown::parse($markdown);

// 永久缓存。(推荐方式)
GitDown::parseAndCache($markdown);

// 缓存24小时 (Laravel 5.8 以下的单位是分钟,否则就是秒)
GitDown::parseAndCache($markdown, $seconds = 86400);

// 传递自定义的缓存策略
GitDown::parseAndCache($markdown, function ($parse) {
    return Cache::rememberForever(sha1($markdown), function () use ($parse) {
        return $parse();
    });
});

并非一定要在 Laravel 中使用 GitDown---你可以创建一个 GitDown\GitDown 实例,然后使用自己的缓存策略:

$gitDown = new GitDown\GitDown(
    $token = 'foo',
    $context = 'your/repo',
    $allowIframes = false
);

$gitDown->parse($markdown);

// 传递自定义的缓存策略
$gitDown->parseAndCache($markdown, function ($parse) {
    return Cache::rememberForever(sha1($markdown), function () use ($parse) {
        return $parse();
    });
});

一定要注意如果你不缓存结果很快就会遇到 GitHub 接口限速,然后你的页面就会加载的奇慢无比。

在前端页面,你可以在 Laravel 项目的 <head> 布局下利用 @gitdown 指令 ,在 class 为 .markdown-body 的块级元素下嵌套 markdown 内容:

<head>
    [...]
    @gitdown
</head>
<body>
    <div class="markdown-body">
        {!! GitDown::parseAndCache($content) !!}
    </div>
</body>

如果你使用的不是 Laravel,你可以按照如下方式使用:

<style><?php echo GitDown\GitDown::styles(); ?></style>

查阅项目的 README 文件可以获得更多渲染样式的细节。

原文地址:https://laravel-news.com/gitdown-parsing...

译文地址:https://learnku.com/laravel/t/25230

本文为协同翻译文章,如您发现瑕疵请点击「改进」按钮提交优化建议
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
讨论数量: 4
Soldoros

感觉这个有点鸡肋,没想到什么场景下玩这个。。。

5个月前 评论
Summer

@Soldoros 如果想完整地支持 GitHub Flavored Markdown 语法,好像就只有这种方法,市面上的解析器多多少少会缺一些语法。

5个月前 评论
Soldoros

@Summer 了解了!

5个月前 评论

@Summer learnku.com的Markdown用起来和看起来都是挺舒服的啊

4个月前 评论

请勿发布不友善或者负能量的内容。与人为善,比聪明更重要!