PHPackages medienbaecker/kirby-help-view - 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. [Admin Panels](/categories/admin) 4. / 5. medienbaecker/kirby-help-view ActiveKirby-plugin[Admin Panels](/categories/admin) medienbaecker/kirby-help-view ============================= Display help articles directly in the Kirby Panel 1.2.0(4mo ago)26552MITPHP Since Dec 10Pushed 1mo ago1 watchersCompare [ Source](https://github.com/medienbaecker/kirby-help-view)[ Packagist](https://packagist.org/packages/medienbaecker/kirby-help-view)[ RSS](/packages/medienbaecker-kirby-help-view/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (6)Dependencies (2)Versions (4)Used By (0) Kirby Help View =============== [](#kirby-help-view) A [Kirby](https://getkirby.com/) plugin that adds a help view to the Panel for your clients. Features -------- [](#features) - Custom Panel area with help articles - Supports categories with nested articles - KirbyText in articles (links, images, formatting) - Icons and colors for each article card - Previous/next navigation between articles - Breadcrumbs for nested articles - Multilanguage support [![Screenshot of the overview with cards for help articles](https://private-user-images.githubusercontent.com/7975568/524996197-996aa373-e4ad-4104-9c36-0401ff12d59d.webp?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzM5MDA0MzcsIm5iZiI6MTc3MzkwMDEzNywicGF0aCI6Ii83OTc1NTY4LzUyNDk5NjE5Ny05OTZhYTM3My1lNGFkLTQxMDQtOWMzNi0wNDAxZmYxMmQ1OWQud2VicD9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjAzMTklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwMzE5VDA2MDIxN1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTQ1YzA5NGQ4ZjllNGE5ODZkNWFmZWU4YzBiODA0OGIxMWMwYjhiOTljYzQxM2FmOWYxOGI3ZWUyNDQwZWY4NGYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.8lojXp03jBLp3ypHBlEeWtFZ-E8Gqm_4UWM02Q4V28A)](https://private-user-images.githubusercontent.com/7975568/524996197-996aa373-e4ad-4104-9c36-0401ff12d59d.webp?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzM5MDA0MzcsIm5iZiI6MTc3MzkwMDEzNywicGF0aCI6Ii83OTc1NTY4LzUyNDk5NjE5Ny05OTZhYTM3My1lNGFkLTQxMDQtOWMzNi0wNDAxZmYxMmQ1OWQud2VicD9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjAzMTklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwMzE5VDA2MDIxN1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTQ1YzA5NGQ4ZjllNGE5ODZkNWFmZWU4YzBiODA0OGIxMWMwYjhiOTljYzQxM2FmOWYxOGI3ZWUyNDQwZWY4NGYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.8lojXp03jBLp3ypHBlEeWtFZ-E8Gqm_4UWM02Q4V28A)[![Screenshot of an article view](https://private-user-images.githubusercontent.com/7975568/524996196-5f389432-cefe-4c6c-813b-1f9f0035b5fd.webp?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzM5MDA0MzcsIm5iZiI6MTc3MzkwMDEzNywicGF0aCI6Ii83OTc1NTY4LzUyNDk5NjE5Ni01ZjM4OTQzMi1jZWZlLTRjNmMtODEzYi0xZjlmMDAzNWI1ZmQud2VicD9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjAzMTklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwMzE5VDA2MDIxN1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTgxNjZmOTNhNzEyOTJjNWVjMjA5MTIxOTgwYmNmM2MzMDM0MWY2YzBkZThmNzIwMTAyYmIxMTFmODU3OGI3MjAmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.5HurzaALNAt3oV4YE-5q3x1lF8qXiAOWVVX2LrNs_aM)](https://private-user-images.githubusercontent.com/7975568/524996196-5f389432-cefe-4c6c-813b-1f9f0035b5fd.webp?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzM5MDA0MzcsIm5iZiI6MTc3MzkwMDEzNywicGF0aCI6Ii83OTc1NTY4LzUyNDk5NjE5Ni01ZjM4OTQzMi1jZWZlLTRjNmMtODEzYi0xZjlmMDAzNWI1ZmQud2VicD9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjAzMTklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwMzE5VDA2MDIxN1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTgxNjZmOTNhNzEyOTJjNWVjMjA5MTIxOTgwYmNmM2MzMDM0MWY2YzBkZThmNzIwMTAyYmIxMTFmODU3OGI3MjAmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.5HurzaALNAt3oV4YE-5q3x1lF8qXiAOWVVX2LrNs_aM) Content Structure ----------------- [](#content-structure) Create a `site/help` folder with your articles: ``` site/help/ ├── 1_getting-started/ │ ├── article.txt │ ├── article.de.txt │ └── article.ja.txt ├── 2_editing/ │ ├── category.txt │ ├── 1_text/article.txt │ └── 2_images/article.txt └── 3_settings/article.txt ``` - Number prefixes (`1_`, `2_`) control the order - Folders with `article.txt` become articles - Folders without `article.txt` but with subfolders containing articles become categories. You can add an optional `category.txt` to overwrite the title. - For multilanguage support, add language codes to filenames (e.g. `article.de.txt`). Depending on the user's Panel language, the appropriate article version will be shown. Seems familiar, doesn't it? I tried to keep it close to Kirby's content structure while also keeping it out of the actual site content so you don't accidentally expose help articles on the public site. ### Example article [](#example-article) ``` # site/help/1_getting-started/article.txt Title: Getting Started ---- Icon: book ---- Color: blue-600 ---- Back: blue-200 ---- Text: ## Welcome Your help content here with **KirbyText** support. (image: screenshot.png) ``` You can define an icon from Kirby's [icon set](https://getkirby.com/docs/reference/panel/icons) and colors from the Kirby [color variables](https://lab.getkirby.com/public/lab/basics/design/colors). ### Example category [](#example-category) ``` # site/help/2_editing/category.txt Title: Editing Content ``` If you don't add a `category.txt`, the folder name will be used as the title (e.g. "2\_editing" → "Editing"). If you're not having to deal with German Ümläuts (or other fancy characters) in your folder names, don't worry about it. Options ------- [](#options) ``` // site/config/config.php return [ 'medienbaecker.help-view' => [ 'root' => '/path/to/custom/help/folder' ] ]; ``` Notes ----- [](#notes) - Files in articles (images, videos, etc.) are served via an API route *without* authentication. This means help files are technically accessible without Panel login if someone guesses the URL. For most use cases this is fine since help content isn't sensitive but be aware of this if you include confidential information in help files. If you have a better idea how to handle this, please let me know. - The help menu item only appears if the `site/help` folder exists. Requirements ------------ [](#requirements) Kirby 5.2.0 or higher (I'm using the new `Str::label()` method) Installation ------------ [](#installation) ### Composer [](#composer) ``` composer require medienbaecker/kirby-help-view ``` ### Manual [](#manual) Download and copy this repository to `site/plugins/kirby-help-view`. Credits ------- [](#credits) [kirby-helpsection](https://github.com/amteich/kirby-helpsection) by amteich was the original inspiration for this plugin. I've been using it for years and my clients loved it. Unfortunately it has not been updated since 2021 and is not compatible with Kirby 5, so I created this new version from scratch, trying to stick to core components as much as possible. ### Health Score 40 — FairBetter than 88% of packages Maintenance84 Actively maintained with recent releases Popularity21 Limited adoption so far Community11 Small or concentrated contributor base Maturity37 Early-stage or recently created project Bus Factor1 Top contributor holds 91.7% 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 ~12 days Total 3 Last Release 127d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/7975568?v=4)[Thomas Günther](/maintainers/medienbaecker)[@medienbaecker](https://github.com/medienbaecker) --- Top Contributors [![medienbaecker](https://avatars.githubusercontent.com/u/7975568?v=4)](https://github.com/medienbaecker "medienbaecker (11 commits)")[![danburzo](https://avatars.githubusercontent.com/u/205375?v=4)](https://github.com/danburzo "danburzo (1 commits)") ### Embed Badge ![Health badge](/badges/medienbaecker-kirby-help-view/health.svg) ``` [![Health](https://phpackages.com/badges/medienbaecker-kirby-help-view/health.svg)](https://phpackages.com/packages/medienbaecker-kirby-help-view) ``` ### Alternatives [filament/spatie-laravel-media-library-plugin Filament support for `spatie/laravel-medialibrary`. 1764.8M125](/packages/filament-spatie-laravel-media-library-plugin)[distantnative/retour-for-kirby Manage redirects and track 404s right from the Kirby CMS Panel 14689.4k1](/packages/distantnative-retour-for-kirby)[filament/infolists Easily add beautiful read-only infolists to any Livewire component. 1220.8M36](/packages/filament-infolists)[getkirby/staticache Static site performance on demand 9615.4k](/packages/getkirby-staticache)[pechente/kirby-admin-bar Kirby Admin Bar 512.2k](/packages/pechente-kirby-admin-bar)[pechente/kirby-password-guard Kirby Password Guard 345.0k](/packages/pechente-kirby-password-guard) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)