Download the PHP package riimu/sami-config without Composer
On this page you can find all versions of the php package riimu/sami-config. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download riimu/sami-config
More information about riimu/sami-config
Files in riimu/sami-config
Package sami-config
Short Description Automatic configuration provider for Sami documentation generator
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package sami-config
Riimu's Automatic Sami Configuration
I personally use Sami for generating API documentation for number of my projects. However, to generate that documentation, I need to set up a configuration for each project that only varies slightly per project. Thus I created this composer package that can automatically figure out the configuration and set it up properly for each project.
Essentially, by using this automatic configuration utility, you can have Sami configured with some defaults that are figured from rest of the project files rather than having to manually duplicate them into the Sami config.
Usage
To add this configuration utility to your project, you should first include it via composer:
Then you should create a file named sami_config.php in your project root directory that simply contains
The sami_config.php can now be used as the configuration for the documentation generator, e.g.
Automatic Configurations
Source
The documentation is generted from the src directory in the project root directory.
Theme
No theme will be set for the generated documentation, but you can use environmental variable SAMI_THEME to
set a theme by setting it to a path to directory that contains a theme manifest.yml. The directory name and
the name of the theme must match.
Title
The title for the documentation is parsed from the root README.md file by taking text from the first line,
which is indicated by markdown as a title. Then the word API is appended to it.
For example, if documentation was generated from this repository, the title would be
Riimu's Automatic Sami Configuration API.
If no title can be determined, an exception will be thrown and the process is interrupted.
Versions
The configuration utility automatically looks up the latest semver stable tag from the repository and checkouts that
for the purpose of generating the documentation. Not that if you create the tags as releases in Github, remember
to run git fetch in order to also get the tags locally.
After the documentation is generated, the previous selected working state is checked out again.
If no applicable tags can be found or the workspace is not clean for checking out another tag, an exception will be thrown and the process interrupted.
Build directory
The build directory will be set to build/doc and the cache path to build/cache in the project root directory.
Do note that both of these directories will be cleared entirely before the documentation generation process.
Remote Repository URL
The repository url will be set as a github repository url based on what is set as the url for origin remote in the
local git repository.
If no valid github url is set as the remote url for origin, an exception will be thrown and the process interrupted.
Credits
This package is Copyright (c) 2018 Riikka Kalliomäki.
See LICENSE for license and copying information.
