README

skizu/gitdown 结合了 git 仓库和 PHP 的 Markdown 解析器，支持完整的 CommonMark 规范

目标

完全支持 CommonMark 规范（100% 兼容性）
提供一个可扩展的 git 库集成组件
能够加载、比较和解析 git 仓库中 Markdown 文件的版本

安装

此项目可以通过 Composer 进行安装

$ composer require skizu/gitdown

基本用法

GitDownConverter 类提供了一个简单包装器，用于将 git 仓库中的 CommonMark 文件转换为 HTML

use Skizu\GitDown\GitDownConverter;

$gitDownConverter = new GitDownConverter('/path/to/repo');
echo $gitDownConverter->convertToHtml('path/to/file.md');

// <h1>Hello World!</h1>

GitDownDiff 类提供了一个简单包装器，用于在 git 仓库中的 CommonMark 文件上执行差异比较

use Skizu\GitDown\GitDownDiff
 
$gitDownDiff = new GitDownDiff('/path/to/repo');
$diff = $gitDownDiff->getDiff('master@{2 days ago}..master');
 
foreach($diff as $file => $data) {
   echo '<h1>'.$file.'<h1>';
   foreach($data['lines'] as $line) {
      echo $line;
   }
}
 
// <h1>README.md</h1>
// -* Fully support the CommonMark spec (100% compliance)\n
// +* Fully support the [CommonMark spec] (100% compliance)\n

skizu / gitdown

维护者

详细信息

README

目标

安装

基本用法