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 项目的
布局下利用 @gitdown 指令 ,在 class 为 .markdown-body 的块级元素下嵌套 markdown 内容:[...]
@gitdown
{!! GitDown::parseAndCache($content) !!}
如果你使用的不是 Laravel,你可以按照如下方式使用:
查阅项目的 README 文件可以获得更多渲染样式的细节。
本文中的所有译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。