devedge/sami-github

A Sami theme for GitHub Markdown formatted documentation. (this is a fork of phine/sami-github)

Maintainers

Details

github.com/ppetermann/sami-github

Homepage

Source

Issues

Installs: 2 589

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 8

1.0.6 2018-02-22 13:41 UTC

Requires (Dev)

MIT 18ae11b215368362b77981d4e676e993f0b2018d

githubsami

This package is auto-updated.

Last update: 2024-11-26 02:45:47 UTC

README

This is a fork of phine/sami-github, with a few fixes as the original project is abandoned.

A Sami theme for GitHub Markdown formatted documentation.

Usage

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,
));

Requirement

  • PHP >= 5.3.3
  • Sami >= 1.1.0

Installation

Via Composer:

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

License

This library is available under the MIT license.