PHPackages awema-pl/module-docs - 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. [Utility & Helpers](/categories/utility) 4. / 5. awema-pl/module-docs ActiveLibrary[Utility & Helpers](/categories/utility) awema-pl/module-docs ==================== Package for wiki output v1.0.8(5y ago)0161MITPHP Since Sep 10Pushed 5y ago1 watchersCompare [ Source](https://github.com/awema-pl/module-docs)[ Packagist](https://packagist.org/packages/awema-pl/module-docs)[ Docs](https://awema.pl)[ RSS](/packages/awema-pl-module-docs/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependencies (4)Versions (10)Used By (1) Docs ==== [](#docs) [![Coverage report](https://camo.githubusercontent.com/a8a22eb78931ff54160972882edecb8156bba3024495ffcccb7a0715619a8d57/687474703a2f2f6769746c61622e6177656d612e706c2f6177656d612d706c2f6d6f64756c652d646f63732f6261646765732f6d61737465722f636f7665726167652e737667)](https://www.awema.pl/)[![Build status](https://camo.githubusercontent.com/91d84cf9b61b7bea0637a5d1213f26253528968f1534b6432ff8f4eed0630797/687474703a2f2f6769746c61622e6177656d612e706c2f6177656d612d706c2f6d6f64756c652d646f63732f6261646765732f6d61737465722f6275696c642e737667)](https://www.awema.pl/)[![Composer Ready](https://camo.githubusercontent.com/23a514509da8996f6a6fa86b84ff27ad5ed18ce9d8b05c2dac54a680c03bb8c4/68747470733a2f2f7777772e6177656d612e706c2f6177656d612d706c2f6d6f64756c652d646f63732f7374617475732e737667)](https://www.awema.pl/)[![Downloads](https://camo.githubusercontent.com/48275294ef2275e2318a949c4a28d9b21adcf11112739bf2c9cef02b29122c27/68747470733a2f2f7777772e6177656d612e706c2f6177656d612d706c2f6d6f64756c652d646f63732f646f776e6c6f6164732e737667)](https://www.awema.pl/)[![Last version](https://camo.githubusercontent.com/dbc6d9aa0f49e75d821f65fb85f6f6fd801c673502b6b82f2f138ffe0fcc20ae/68747470733a2f2f7777772e6177656d612e706c2f6177656d612d706c2f6d6f64756c652d646f63732f76657273696f6e2e737667)](https://www.awema.pl/) Awema packages documentation reader Installation ------------ [](#installation) Via Composer ``` $ composer require awema-pl/module-docs ``` The package will automatically register itself. You can publish the views with: ``` php artisan vendor:publish --provider="AwemaPL\Docs\DocsServiceProvider" --tag="views" ``` You can publish the config file with: ``` php artisan vendor:publish --provider="AwemaPL\Docs\DocsServiceProvider" --tag="config" ``` Adding docs routes ------------------ [](#adding-docs-routes) Add to `routes\web.php` ``` Docs::routes(); ``` Examples of use --------------- [](#examples-of-use) ``` use Docs; Docs::all($withDocs = true); Docs::get(['package1' => ['1.0', '2.6'], 'package2' => '1.3', 'package3'], 'package4', $withDocs = true); Docs::package('package1', $withDocs = true); Docs::versions('package1', $withDocs = true); Docs::version('package1', '1.0', $withDocs = true); Docs::files('package1', '1.0', $withDocs = true); Docs::file('package1', '1.0', 'file.md'); Docs::fileContent('package1', '1.0', 'file.md'); Docs::list(); Docs::list('package1'); Docs::list('package1', '1.0'); Docs::list('package1', '1.0', 'file.md'); ``` Methods ------- [](#methods) #### all() [](#all) `Docs::all($withDocs = true);` Output: ``` [ [ "name" => "package1", "versions" => [ [ "name" => "1.0", "files" => [ [ "name" => "index.md", "content" => "# Title" ], [ "name" => "doc1.md", "content" => "Doc 1 content" ] ] ], ... [ "name" => "2.6", "files" => [ ... ] ] ] ], ... [ "name" => "package4", "versions" => [ ... ] ] ] ``` Input param `$withDocs` is bollean, optional and is true by default. if `$withDocs == false` file content will be null #### get() [](#get) `Docs::get(['package1' => ['1.0', '2.6'], 'package2' => '1.3', 'package3'], 'package4', $withDocs = true);` Last bool param `$withDocs` is optional and is true by default Method output is the same as for all(), but will contain only specified in args packages and versions. If packages are not listed result will contain all packages. If versions for specified package is not listed result will contain all versions for that package ### package() [](#package) `Docs::package('package1', $withDocs = true);` Output: ``` [ "name" => "package1", "versions" => [ [ "name" => "1.0", "files" => [ [ "name" => "index.md", "content" => "# Title" ], [ "name" => "doc1.md", "content" => "Doc 1 content" ] ] ], ... [ "name" => "2.6", "files" => [ ... ] ] ] ] ``` If package is not in the docs, result will be `null`. Last bool param `$withDocs` is optional and is true by default. If `$withDocs == false` file `content` will be null. ### versions() [](#versions) `Docs::versions('package1', $withDocs = true);` Output: ``` [ [ "name" => "1.0", "files" => [ [ "name" => "index.md", "content" => "# Title" ], [ "name" => "doc1.md", "content" => "Doc 1 content" ] ] ], ... [ "name" => "2.6", "files" => [ ... ] ] ] ``` If package is not in the docs, result will be `null`. Last bool param `$withDocs` is optional and is true by default. If `$withDocs == false` file `content` will be null. ### version() [](#version) `Docs::version('package1', '1.0', $withDocs = true);` Output: ``` [ "name" => "1.0", "files" => [ [ "name" => "index.md", "content" => "# Title" ], [ "name" => "doc1.md", "content" => "Doc 1 content" ] ] ] ``` If package or version is not in the docs, result will be `null`. Last bool param `$withDocs` is optional and is true by default. If `$withDocs == false` file `content` will be null. ### files() [](#files) `Docs::files('package1', '1.0', $withDocs = true);` Output: ``` [ [ "name" => "index.md", "content" => "# Title" ], [ "name" => "doc1.md", "content" => "Doc 1 content" ] ] ``` If package or version is not in the docs, result will be `null`. Last bool param `$withDocs` is optional and is true by default. If `$withDocs == false` file `content` will be null. ### file() [](#file) `Docs::file('package1', '1.0', 'file.md');` Output: ``` [ "name" => "index.md", "content" => "# Title" ] ``` If package or version or file is not in the docs, result will be `null`. ### fileContent() [](#filecontent) `Docs::fileContent('package1', '1.0', 'file.md');` Result is file content string or `null` if file does not exists ### list() [](#list) `Docs::list();` Output is array of packages names ``` [ "package1", "package2", ... "package6" ] ``` `Docs::list('package1');` Output is array of package versions names ``` [ "0.1", "0.2", ... "2.18" ] ``` If package is not in the docs, result will be `null`. `Docs::list('package1', '1.0');` Output is array of package version files names ``` [ "index.md", "doc1.md", ... "doc4.md" ] ``` If package or version is not in the docs, result will be `null`. `Docs::list('package1', '1.0', 'file.md');` Result is file content string or `null` if file does not exists Testing ------- [](#testing) You can run the tests with: ``` composer test ``` Contributing ------------ [](#contributing) Please see [contributing.md](contributing.md) for details and a todolist. Security -------- [](#security) If you discover any security related issues, please email :author\_email instead of using the issue tracker. Credits ------- [](#credits) - [Ivan Slesarenko](https://github.com/boomdraw) License ------- [](#license) license. Please see the [license file](license.md) for more information. ### Health Score 26 — LowBetter than 43% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity6 Limited adoption so far Community9 Small or concentrated contributor base Maturity60 Established project with proven stability 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 ~9 days Recently: every ~19 days Total 9 Last Release 1999d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/68942388?v=4)[Awema](/maintainers/awema-pl)[@awema-pl](https://github.com/awema-pl) --- Top Contributors [![nepras](https://avatars.githubusercontent.com/u/13780106?v=4)](https://github.com/nepras "nepras (8 commits)") --- Tags laraveldocs ### Embed Badge ![Health badge](/badges/awema-pl-module-docs/health.svg) ``` [![Health](https://phpackages.com/badges/awema-pl-module-docs/health.svg)](https://phpackages.com/packages/awema-pl-module-docs) ``` ### Alternatives [barryvdh/laravel-ide-helper Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion. 14.9k123.0M687](/packages/barryvdh-laravel-ide-helper)[tightenco/jigsaw Simple static sites with Laravel's Blade. 2.2k438.5k29](/packages/tightenco-jigsaw)[bjuppa/laravel-blog Add blog functionality to your Laravel project 483.3k2](/packages/bjuppa-laravel-blog)[interaction-design-foundation/laravel-geoip Support for multiple Geographical Location services. 17221.0k3](/packages/interaction-design-foundation-laravel-geoip)[nedwors/navigator A Laravel package to ease defining navigation menus 433.1k](/packages/nedwors-navigator) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)