Download the PHP package csoellinger/dog-html-printer without Composer
On this page you can find all versions of the php package csoellinger/dog-html-printer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download csoellinger/dog-html-printer
More information about csoellinger/dog-html-printer
Files in csoellinger/dog-html-printer
Package dog-html-printer
Short Description HTML printer for Dog, a simple code 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 dog-html-printer
csoellinger/dog-html-printer
HTML printer for Dog, a simple code documentation generator.
- About
- Installation
- Usage
- Documentation / Demo
- Contributing
- Known Issues
- ToDo
- Copyright and License
About
A HTML printer for Dog PHP Documentation Generator. It is heavily inspired by Doctum, phpDox and other good projects. The printer is Work-In-Progress at the moment but it is already very configurable and has a nice look with many features like: Tree Navigation, Source Code implementation, PhpLoc overview, readme renderer and some more are planned. Take a look at the todo section.
Installation
First: You need to install Dog PHP Documentation Generator.
Second: For now you have to allow minimum stability dev inside composer file cause the latest version of highlight.php works like a charm but isn't released yet, so we use the dev-master branch.
Add this to your composer.json file:
At least install the html printer:
Usage
After you have installed Dog and Dog HTML printer you can customize your .dog.yml to use the new printer class.
Right after customizing the configuration you can start building your documentation.
Documentation / Demo
https://csoellinger.github.io/dog-html-printer
Contributing
Contributions are welcome! To contribute, please familiarize yourself with CONTRIBUTING.md.
If you found a bug or have an idea feel free to post it here on github.
Known Issues
- [ ] Linking inside readme to other markdown files causes problems
- [ ] Collapse tree navigation also selects item
ToDo
- [ ] Generate local static search
- [ ] Include coverage data to printer output
- [ ] Include testing data to printer output
- [ ] Project testing
- [ ] Mobile optimization
- [ ] Replace or customize bootstrap with only needed stuff
- [ ] Sub-Dir layout config instead of flat dir output.
- [ ] Optimize
- Strip bootstrap down to only needed components
- Some code parts are a bit "hacky"
- [ ] Theming
- Append custom css via printer config
- Theming system to use a new theme without writing a new printer class (like "custom templates path")
Copyright and License
The csoellinger/dog-html-printer library is copyright © Christopher Söllinger and licensed for use under the terms of the MIT License (MIT). Please see LICENSE for more information.
All versions of dog-html-printer with dependencies
doctrine/inflector Version ^2.0
klitsche/dog Version ^0.4
league/commonmark Version ^1.5
odan/twig-assets Version ^3.2
scrivo/highlight.php Version dev-master
twig/markdown-extra Version ^3.2
wyrihaximus/html-compress Version ^4.1