devedge/sami-github

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

维护者

详细信息

github.com/ppetermann/sami-github

主页

源代码

问题

安装量: 2,559

依赖项: 1

建议者: 0

安全性: 0

星标: 0

关注者: 2

分支: 8

1.0.6 2018-02-22 13:41 UTC

Requires (Dev)

MIT 18ae11b215368362b77981d4e676e993f0b2018d

githubsami

This package is auto-updated.

Last update: 2024-08-26 02:05:15 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 "devedge/sami-github=~1.0"

许可证

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