Download the PHP package nochso/sami-theme without Composer
On this page you can find all versions of the php package nochso/sami-theme. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nochso/sami-theme
More information about nochso/sami-theme
Files in nochso/sami-theme
Package sami-theme
Short Description A Sami theme with inline source code
License ISC
Homepage https://github.com/nochso/sami-theme
Informations about the package sami-theme
nochso/sami-theme Theme for the Sami API doc generator
This is a theme for the Sami API documentation generator with some added features:
- The complete file source is included at the end.
- Source code highlighting with prismjs.
- Show the value / assignment of class constants.
- HTML is minified using wyrihaximus/html-compress.
An an example take a look at the API docs for the nochso/Benchmark library.
Installation
If you haven't used Sami before, please read up on its installation and basic usage first.
When you're ready, require the theme in your project:
Usage
In your Sami configuration file simply call Theme::prepare
to
inject the theme into your Sami instance right before returning it:
e.g.
This looks for PHP files in src/
and saves the resulting documentation in build/
.
These results are now ready for you to upload and share!
History
0.2.0 - 2016-04-17
Changed
- Bump nochso/html-compress-twig to 1.0.0
0.1.1 - 2015-10-05
Changed
- Use nochso/html-compress-twig as Twig extension around wyrihaximus/html-compress.
0.1.0 - 2015-09-26
First public release.
Contributing
- Open an issue if it's worth discussing.
- Fork this project on Github.
- Clone your fork:
git clone [email protected]:yourname/sami-theme.git
- Don't forget to
composer update
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request on Github :)
Credits
License
This project is licensed under the ISC license which is MIT/GPL compatible and FSF/OSI approved: