{"id":22104685,"url":"https://github.com/riimu/sami-config","last_synced_at":"2025-03-24T02:43:09.578Z","repository":{"id":62535822,"uuid":"141551955","full_name":"Riimu/sami-config","owner":"Riimu","description":"Automatic configuration provider for Sami documentation generator","archived":false,"fork":false,"pushed_at":"2018-07-19T09:59:25.000Z","size":6,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-01T12:46:02.264Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Riimu.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2018-07-19T08:56:47.000Z","updated_at":"2018-12-19T20:43:44.000Z","dependencies_parsed_at":"2022-11-02T14:47:54.091Z","dependency_job_id":null,"html_url":"https://github.com/Riimu/sami-config","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Riimu%2Fsami-config","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Riimu%2Fsami-config/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Riimu%2Fsami-config/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Riimu%2Fsami-config/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Riimu","download_url":"https://codeload.github.com/Riimu/sami-config/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245200669,"owners_count":20576673,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":"2024-12-01T06:34:09.811Z","updated_at":"2025-03-24T02:43:09.559Z","avatar_url":"https://github.com/Riimu.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Riimu's Automatic Sami Configuration #\n\nI personally use [Sami] for generating API documentation for number of my projects. However, to generate that\ndocumentation, I need to set up a configuration for each project that only varies slightly per project. Thus\nI created this composer package that can automatically figure out the configuration and set it up properly\nfor each project.\n\nEssentially, by using this automatic configuration utility, you can have Sami configured with some defaults\nthat are figured from rest of the project files rather than having to manually duplicate them into the\nSami config.\n\n[![Travis](https://img.shields.io/travis/Riimu/sami-config.svg?style=flat-square)](https://travis-ci.org/Riimu/sami-config)\n[![Packagist](https://img.shields.io/packagist/v/riimu/sami-config.svg?style=flat-square)](https://packagist.org/packages/riimu/sami-config)\n\n## Usage ##\n\nTo add this configuration utility to your project, you should first include it via composer:\n\n```\n$ composer require --dev riimu/sami-config\n```\n\nThen you should create a file named `sami_config.php` in your project root directory that simply contains\n\n```php\n\u003c?php\n\nreturn require __DIR__ . '/vendor/riimu/sami-config/config.php';\n```\n\nThe `sami_config.php` can now be used as the configuration for the documentation generator, e.g.\n\n```\n$ sami.php update sami_config.php\n```\n\n## Automatic Configurations ##\n\n### Source ###\n\nThe documentation is generted from the `src` directory in the project root directory.\n\n### Theme ###\n\nNo theme will be set for the generated documentation, but you can use environmental variable `SAMI_THEME` to\nset a theme by setting it to a path to directory that contains a theme `manifest.yml`. The directory name and\nthe name of the theme must match.\n\n### Title ###\n\nThe title for the documentation is parsed from the root `README.md` file by taking text from the first line,\nwhich is indicated by markdown as a title. Then the word `API` is appended to it.\n\nFor example, if documentation was generated from this repository, the title would be\n`Riimu's Automatic Sami Configuration API`.\n\nIf no title can be determined, an exception will be thrown and the process is interrupted.\n\n### Versions ###\n\nThe configuration utility automatically looks up the latest semver stable tag from the repository and checkouts that\nfor the purpose of generating the documentation. Not that if you create the tags as releases in Github, remember\nto run `git fetch` in order to also get the tags locally.\n\nAfter the documentation is generated, the previous selected working state is checked out again.\n\nIf no applicable tags can be found or the workspace is not clean for checking out another tag, an exception will be\nthrown and the process interrupted.\n\n### Build directory ###\n\nThe build directory will be set to `build/doc` and the cache path to `build/cache` in the project root directory.\nDo note that both of these directories will be cleared entirely before the documentation generation process.\n\n### Remote Repository URL ###\n\nThe repository url will be set as a github repository url based on what is set as the url for `origin` remote in the\nlocal git repository.\n\nIf no valid github url is set as the remote url for `origin`, an exception will be thrown and the process interrupted.\n\n## Credits ##\n\nThis package is Copyright (c) 2018 Riikka Kalliomäki.\n\nSee LICENSE for license and copying information.\n\n[Sami]: https://github.com/FriendsOfPHP/Sami\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Friimu%2Fsami-config","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Friimu%2Fsami-config","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Friimu%2Fsami-config/lists"}