avtomon/sami-github

GitHub Markdown 格式文档的 Sami 主题。（这是 phine/sami-github 的分支）

维护者

详细信息

github.com/avtomon/sami-github

主页

源代码

问题

安装: 49

依赖项: 1

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 8

开放问题: 0

语言:Twig

1.0.7 2020-01-08 09:52 UTC

Requires (Dev)

MIT e08bed01b8dfd9422a4b4fafc2c1788e056b63cb

githubsami

This package is auto-updated.

Last update: 2024-09-16 20:14:19 UTC

README

这是 phine/sami-github 的分支，对原始项目进行了一些修复，因为原始项目已废弃。

GitHub Markdown 格式文档的 Sami 主题。

用法

use Sami\Sami;
use Sami\Version\GitVersionCollection;
use Symfony\Component\Finder\Finder;

$iterator = Finder::create()
    ->files()
    ->name('*.php')
    ->exclude('Resources')
    ->exclude('Tests')
    ->in($dir = '/path/to/symfony/src')
;

$versions = GitVersionCollection::create($dir)
    ->addFromTags('v2.0.*')
    ->add('2.0', '2.0 branch')
    ->add('master', 'master branch')
;

return new Sami($iterator, array(
    'theme'                => 'github',
    'versions'             => $versions,
    'title'                => 'Symfony2 API',
    'build_dir'            => __DIR__.'/../build/sf2/%version%',
    'cache_dir'            => __DIR__.'/../cache/sf2/%version%',
    // use a custom theme directory
    'template_dirs'        => array(__DIR__.'/themes/sami-github'),
    'default_opened_level' => 2,
));

要求

  • PHP >= 5.3.3
  • Sami >= 1.1.0

安装

通过Composer

$ composer require "avtomon/sami-github=~1.0"

许可证

此库可在MIT 许可证下获得。