phine / sami-github

此包已被弃用且不再维护。未建议替代包。

GitHub Markdown 格式文档的 Sami 主题。

维护者

详细信息

github.com/kherge-archive/sami-github

主页

源代码

问题

安装次数: 2,254

依赖者: 1

建议者: 0

安全: 0

星标: 6

关注者: 2

分支: 8

1.0.4 2013-09-18 21:28 UTC

Requires (Dev)

MIT ded4faf3900ee40c5fb8911574bc2ad0bd352c70

githubsami

This package is not auto-updated.

Last update: 2021-12-07 01:42:39 UTC

README

Latest Stable Version Total Downloads

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 "phine/sami-github=~1.0"

许可证

此库可在 MIT 许可证 下使用。