PHPackages csoellinger/dog-html-printer - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Templating & Views](/categories/templating) 4. / 5. csoellinger/dog-html-printer ActiveLibrary[Templating & Views](/categories/templating) csoellinger/dog-html-printer ============================ HTML printer for Dog, a simple code documentation generator. v0.3.1(5y ago)02791MITTwigPHP ^7.4 || ^8CI failing Since Feb 15Pushed 5y ago1 watchersCompare [ Source](https://github.com/CSoellinger/dog-html-printer)[ Packagist](https://packagist.org/packages/csoellinger/dog-html-printer)[ RSS](/packages/csoellinger-dog-html-printer/feed)WikiDiscussions main Synced today READMEChangelogDependencies (10)Versions (8)Used By (0) csoellinger/dog-html-printer ============================ [](#csoellingerdog-html-printer) **HTML printer for [Dog](https://github.com/klitsche/dog), a simple code documentation generator.** [![Source Code](https://camo.githubusercontent.com/7bfdf48ece4bbd7bdb694047b2b987e03c9eca8fa406eb81560a7b5553488b75/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736f757263652d63736f656c6c696e6765722f646f672d2d68746d6c2d2d7072696e7465722d626c75652e7376673f7374796c653d666c61742d737175617265)](https://github.com/csoellinger/dog-html-printer)[![Download Package](https://camo.githubusercontent.com/29845eb01f863ad832403a7859caa8923e33061b3785de51c8fa7a6495e9ae72/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f63736f656c6c696e6765722f646f672d68746d6c2d7072696e7465722e7376673f7374796c653d666c61742d737175617265266c6162656c3d72656c65617365)](https://packagist.org/packages/csoellinger/dog-html-printer)[![PHP Programming Language](https://camo.githubusercontent.com/c6f35f552a7db0aac8a8d4e64c22a47091a351ff8358a45da256dc5fd34acfe0/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f63736f656c6c696e6765722f646f672d68746d6c2d7072696e7465722e7376673f7374796c653d666c61742d73717561726526636f6c6f72423d253233383839324246)](https://php.net)[![Read License](https://camo.githubusercontent.com/55ca9b717e67b5b5307c7f59cd7ce7fd4b60fdde96905563634c245f0631d584/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f63736f656c6c696e6765722f646f672d68746d6c2d7072696e7465722e7376673f7374796c653d666c61742d73717561726526636f6c6f72423d6461726b6379616e)](https://github.com/csoellinger/dog-html-printer/blob/master/LICENSE)[![Package downloads on Packagist](https://camo.githubusercontent.com/c72f5ec03eab4b77dccefb517144431897eb22d20b49dfc23fdf608fba5e0973/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f63736f656c6c696e6765722f646f672d68746d6c2d7072696e7465722e7376673f7374796c653d666c61742d73717561726526636f6c6f72423d6461726b6d6167656e7461)](https://packagist.org/packages/csoellinger/dog-html-printer/stats) - [About](#about) - [Installation](#installation) - [Usage](#usage) - [Documentation / Demo](#documentation--demo) - [Contributing](#contributing) - [Known Issues](#known-issues) - [ToDo](#todo) - [Copyright and License](#copyright-and-license) About ----- [](#about) A HTML printer for [Dog PHP Documentation Generator](https://github.com/klitsche/dog). 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 ------------ [](#installation) First: You need to install [Dog PHP Documentation Generator](https://github.com/klitsche/dog). Second: For now you have to allow minimum stability *dev* inside composer file cause the latest version of [highlight.php](https://github.com/scrivo/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: ``` { "minimum-stability": "dev", "prefer-stable" : true, } ``` At least install the html printer: ``` composer require --dev csoellinger/dog-html-printer ``` Usage ----- [](#usage) After you have installed [Dog](https://github.com/klitsche/dog) and [Dog HTML printer](https://github.com/csoellinger/dog-html-printer) you can customize your *.dog.yml* to use the new printer class. ``` # Most configurations are by the dog package itself. # Title title: 'Dog HTML printer' # Relative or absolute paths to source files - plus patterns to include or exclude path pr files srcPaths: 'src': '/.*\.php$/': true # Configure enrichers to add extra data to project or element items # phploc is supported by DogHtmlPrinter enrichers: phploc: class: Klitsche\Dog\Enrichers\PHPLOC\PHPLOCEnricher file: phploc.json # Set the printer class to DogHtmlPrinter printerClass: 'CSoellinger\DogHtmlPrinter\HtmlPrinter' # Printer configuration printerConfig: # Set a custom template path. If you want do this, best way would be to copy the resources/templates dir # from this package to you project dir and then customize the templates. # templatesPath: 'resources/templates' # If you want add a readme file readme: 'README.md' # Include source code includeSource: true # Ignore code marked as @internal ignoreInternal: true # Ignore private things (methods, properties,...) ignorePrivate: true # Minify CSS and JS at output minifyCssAndJs: true # Minify HTML at output. Slows down the build!! minifyHtml: false # Relative or absolute path to output directory outputDir: 'docs/html' # Optional cache dir cacheDir: 'build/cache' # Enable or disable debug mode - helps when tweaking templates debug: false ``` Right after customizing the configuration you can start building your documentation. ``` vendor/bin/dog ``` Documentation / Demo -------------------- [](#documentation--demo) Contributing ------------ [](#contributing) Contributions are welcome! To contribute, please familiarize yourself with [CONTRIBUTING.md](CONTRIBUTING.md). If you found a bug or have an idea feel free to post it here on github. ### Known Issues [](#known-issues) - Linking inside readme to other markdown files causes problems - Collapse tree navigation also selects item ### ToDo [](#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 --------------------- [](#copyright-and-license) The csoellinger/dog-html-printer library is copyright © [Christopher Söllinger](https://github.com/CSoellinger)and licensed for use under the terms of the MIT License (MIT). Please see [LICENSE](LICENSE) for more information. ### Health Score 24 — LowBetter than 32% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity12 Limited adoption so far Community8 Small or concentrated contributor base Maturity47 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~1 days Total 6 Last Release 1902d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/35fd0dd9ad0aaa18f8794b5ab6655cbffd28a7d49b9090ae3e9fd6ea9d7b9818?d=identicon)[CSoellinger](/maintainers/CSoellinger) --- Top Contributors [![CSoellinger-IDS](https://avatars.githubusercontent.com/u/65536111?v=4)](https://github.com/CSoellinger-IDS "CSoellinger-IDS (25 commits)") --- Tags documentationdoggeneratorphpphpprintertwigdocumentationreflectionphpDocumentorgeneratorhtmloutputdog ### Code Quality Static AnalysisPHPStan, Psalm Type Coverage Yes ### Embed Badge ![Health badge](/badges/csoellinger-dog-html-printer/health.svg) ``` [![Health](https://phpackages.com/badges/csoellinger-dog-html-printer/health.svg)](https://phpackages.com/packages/csoellinger-dog-html-printer) ``` ### Alternatives [twig/html-extra A Twig extension for HTML 777.6M41](/packages/twig-html-extra)[nochso/html-compress-twig Twig extension for compressing HTML and inline CSS/Javascript 84468.6k8](/packages/nochso-html-compress-twig)[yellowskies/qr-code-bundle Symfony Barcode & QR Code Generator Bundle with Twig extension 36682.9k](/packages/yellowskies-qr-code-bundle) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)