{"id":30450183,"url":"https://github.com/nochso/sami-theme","last_synced_at":"2026-02-16T06:02:20.984Z","repository":{"id":57027964,"uuid":"43200691","full_name":"nochso/sami-theme","owner":"nochso","description":"Theme for Sami API doc generator with added features like including highlighted source","archived":false,"fork":false,"pushed_at":"2016-04-17T18:32:40.000Z","size":29,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-06T22:34:34.363Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nochso.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-26T10:00:22.000Z","updated_at":"2023-10-23T00:46:03.000Z","dependencies_parsed_at":"2022-08-23T16:20:41.242Z","dependency_job_id":null,"html_url":"https://github.com/nochso/sami-theme","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/nochso/sami-theme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nochso%2Fsami-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nochso%2Fsami-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nochso%2Fsami-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nochso%2Fsami-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nochso","download_url":"https://codeload.github.com/nochso/sami-theme/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nochso%2Fsami-theme/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29501361,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-16T05:57:17.024Z","status":"ssl_error","status_checked_at":"2026-02-16T05:56:49.929Z","response_time":115,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-08-23T13:25:45.668Z","updated_at":"2026-02-16T06:02:20.971Z","avatar_url":"https://github.com/nochso.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nochso/sami-theme Theme for the Sami API doc generator\n\n[![Latest Stable Version](https://poser.pugx.org/nochso/sami-theme/v/stable)](https://packagist.org/packages/nochso/sami-theme)\n[![License](https://poser.pugx.org/nochso/sami-theme/license)](LICENSE)\n\nThis is a theme for the [Sami] API documentation generator with some added features:\n\n- The complete file source is included at the end.\n- Source code highlighting with [prismjs](http://prismjs.com/).\n- Show the value / assignment of class constants.\n- HTML is minified using [wyrihaximus/html-compress][html-compress].\n\nAn an example take a look at the [API docs](http://nochso.github.io/Benchmark/docs/) for the [nochso/Benchmark](https://github.com/nochso/Benchmark/) library.\n\n## Installation\n\nIf you haven't used [Sami] before, please read up on its installation and basic usage first.\n\nWhen you're ready, require the theme in your project:\n\n```sh\n$ composer require nochso/sami-theme\n```\n\n## Usage\n\nIn your [Sami configuration file](https://github.com/FriendsOfPHP/Sami#configuration) simply call `Theme::prepare` to\ninject the theme into your Sami instance right before returning it:\n\n```php\nreturn \\nochso\\SamiTheme\\Theme::prepare($sami);\n```\n\ne.g.\n```php\n\u003c?php\n\nuse Sami\\Sami;\nuse Symfony\\Component\\Finder\\Finder;\n\n$finder = Finder::create()\n    -\u003efiles()\n    -\u003ename('*.php')\n    -\u003ein(__DIR__.'/src');\n\n$config = array(\n    'title' =\u003e 'Project documentation title',\n    'build_dir' =\u003e __DIR__.'/build',\n    'cache_dir' =\u003e __DIR__.'/cache',\n);\n\n$sami = new Sami($finder, $config);\n$sami = \\nochso\\SamiTheme\\Theme::prepare($sami);\nreturn $sami;\n```\n\nThis looks for PHP files in `src/` and saves the resulting documentation in `build/`.\n\nThese results are now ready for you to upload and share!\n\n## History\n\n### 0.2.0 - 2016-04-17\n#### Changed\n- Bump nochso/html-compress-twig to 1.0.0\n\n### 0.1.1 - 2015-10-05\n#### Changed\n- Use [nochso/html-compress-twig](https://github.com/nochso/html-compress-twig) as Twig extension around [wyrihaximus/html-compress][html-compress].\n\n### 0.1.0 - 2015-09-26\nFirst public release.\n\n## Contributing\n\n1. [Open an issue](https://github.com/nochso/sami-theme/issues/new) if it's worth discussing.\n2. Fork this project on Github.\n3. Clone your fork: `git clone git@github.com:yourname/sami-theme.git`\n4. Don't forget to `composer update`\n4. Create your feature branch: `git checkout -b my-new-feature`\n5. Commit your changes: `git commit -am 'Add some feature'`\n6. Push to the branch: `git push origin my-new-feature`\n7. Submit a pull request on Github :)\n\n## Credits\n\n- [Marcel Voigt](https://github.com/nochso)\n\n## License\nThis project is licensed under the ISC license which is MIT/GPL compatible and FSF/OSI approved:\n\n```\nCopyright (c) 2015, Marcel Voigt \u003cmv@noch.so\u003e\n\nPermission to use, copy, modify, and/or distribute this software for any\npurpose with or without fee is hereby granted, provided that the above\ncopyright notice and this permission notice appear in all copies.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES\nWITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF\nMERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR\nANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES\nWHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN\nACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF\nOR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.\n```\n\n[Sami]: https://github.com/FriendsOfPHP/Sami\n[html-compress]: https://github.com/WyriHaximus/HtmlCompress\n[benchmark-docs]: http://nochso.github.io/Benchmark/docs/index.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnochso%2Fsami-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnochso%2Fsami-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnochso%2Fsami-theme/lists"}