PHPackages                             phine/sami-github - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. phine/sami-github

AbandonedArchivedLibrary

phine/sami-github
=================

A Sami theme for GitHub Markdown formatted documentation.

1.0.4(12y ago)62.3k7[1 issues](https://github.com/kherge-archive/sami-github/issues)MITPHP

Since Sep 13Pushed 12y agoCompare

[ Source](https://github.com/kherge-archive/sami-github)[ Packagist](https://packagist.org/packages/phine/sami-github)[ Docs](https://github.com/phine/sami-github)[ RSS](/packages/phine-sami-github/feed)WikiDiscussions master Synced 4d ago

READMEChangelogDependencies (1)Versions (6)Used By (0)

GitHub
======

[](#github)

[![Latest Stable Version](https://camo.githubusercontent.com/f8a3a7e53fa02beb332fbdef918bf5120c0bf3243b289f3e5c72a00f66c41374/68747470733a2f2f706f7365722e707567782e6f72672f7068696e652f73616d692d6769746875622f762f737461626c652e706e67)](https://packagist.org/packages/phine/sami-github)[![Total Downloads](https://camo.githubusercontent.com/49e3292a6f33e3d635898719ccc1981d70ab1f9e100a2a0e0f34384f42823eac/68747470733a2f2f706f7365722e707567782e6f72672f7068696e652f73616d692d6769746875622f646f776e6c6f6164732e706e67)](https://packagist.org/packages/phine/sami-github)

A Sami theme for GitHub Markdown formatted documentation.

Usage
-----

[](#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
-----------

[](#requirement)

- PHP >= 5.3.3
- [Sami](http://sami.sensiolabs.org/) >= 1.1.0

Installation
------------

[](#installation)

Via [Composer](http://getcomposer.org/):

```
$ composer require "phine/sami-github=~1.0"

```

License
-------

[](#license)

This library is available under the [MIT license](LICENSE).

###  Health Score

33

—

LowBetter than 75% of packages

Maintenance17

Infrequent updates — may be unmaintained

Popularity24

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

5

Last Release

4622d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/9122157?v=4)[Kevin Herrera](/maintainers/kherge)[@kherge](https://github.com/kherge)

---

Top Contributors

[![kherge](https://avatars.githubusercontent.com/u/9122157?v=4)](https://github.com/kherge "kherge (40 commits)")

---

Tags

githubsami

### Embed Badge

![Health badge](/badges/phine-sami-github/health.svg)

```
[![Health](https://phpackages.com/badges/phine-sami-github/health.svg)](https://phpackages.com/packages/phine-sami-github)
```

###  Alternatives

[league/commonmark

Highly-extensible PHP Markdown parser which fully supports the CommonMark spec and GitHub-Flavored Markdown (GFM)

2.9k404.0M702](/packages/league-commonmark)[hwi/oauth-bundle

Support for authenticating users using both OAuth1.0a and OAuth2 in Symfony.

2.4k21.5M69](/packages/hwi-oauth-bundle)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[php-coveralls/php-coveralls

PHP client library for Coveralls API

51413.7M3.4k](/packages/php-coveralls-php-coveralls)[ondram/ci-detector

Detect continuous integration environment and provide unified access to properties of current build

22249.4M33](/packages/ondram-ci-detector)[graham-campbell/github

GitHub Is A GitHub Bridge For Laravel

6411.7M19](/packages/graham-campbell-github)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)