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.3.1(1mo ago)292461[1 issues](https://github.com/medienbaecker/kirby-help-view/issues)MITPHP Since Dec 10Pushed 2mo ago2 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 1w ago READMEChangelog (10)Dependencies (6)Versions (8)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) - Render real Panel buttons and icons inside articles - 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.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3ODU3NTk5NTIsIm5iZiI6MTc4NTc1OTY1MiwicGF0aCI6Ii83OTc1NTY4LzUyNDk5NjE5Ny05OTZhYTM3My1lNGFkLTQxMDQtOWMzNi0wNDAxZmYxMmQ1OWQud2VicD9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA4MDMlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwODAzVDEyMjA1MlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWU4YjI1MDZlZTI3ODg2M2Y3MTI3ODMyNzA5OGY0ZWFlOTFmYTlkMThhMTM2MTlhYmFmYzRiNGUyYmE1NmFmYzYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JnJlc3BvbnNlLWNvbnRlbnQtdHlwZT1pbWFnZSUyRndlYnAifQ.T74X1ClGCO7DPXTlwzAPpAwJraa19eJCYavag42Zu-I)](https://private-user-images.githubusercontent.com/7975568/524996197-996aa373-e4ad-4104-9c36-0401ff12d59d.webp?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3ODU3NTk5NTIsIm5iZiI6MTc4NTc1OTY1MiwicGF0aCI6Ii83OTc1NTY4LzUyNDk5NjE5Ny05OTZhYTM3My1lNGFkLTQxMDQtOWMzNi0wNDAxZmYxMmQ1OWQud2VicD9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA4MDMlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwODAzVDEyMjA1MlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWU4YjI1MDZlZTI3ODg2M2Y3MTI3ODMyNzA5OGY0ZWFlOTFmYTlkMThhMTM2MTlhYmFmYzRiNGUyYmE1NmFmYzYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JnJlc3BvbnNlLWNvbnRlbnQtdHlwZT1pbWFnZSUyRndlYnAifQ.T74X1ClGCO7DPXTlwzAPpAwJraa19eJCYavag42Zu-I)[![Screenshot of an article view](https://private-user-images.githubusercontent.com/7975568/524996196-5f389432-cefe-4c6c-813b-1f9f0035b5fd.webp?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3ODU3NTk5NTIsIm5iZiI6MTc4NTc1OTY1MiwicGF0aCI6Ii83OTc1NTY4LzUyNDk5NjE5Ni01ZjM4OTQzMi1jZWZlLTRjNmMtODEzYi0xZjlmMDAzNWI1ZmQud2VicD9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA4MDMlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwODAzVDEyMjA1MlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTQ5YWM1OTdjNzgwNjY0ZGMzZTVlMjExNjg4ZTU5ZTkwMDIzMTAyMjgxZjA3NmI2ZWZmZjA2MTkwMDQwNWY5MGMmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JnJlc3BvbnNlLWNvbnRlbnQtdHlwZT1pbWFnZSUyRndlYnAifQ.KoiBbxxRypGdjsnaoTGlnr6a555FoWkSaLabyG5upk4)](https://private-user-images.githubusercontent.com/7975568/524996196-5f389432-cefe-4c6c-813b-1f9f0035b5fd.webp?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3ODU3NTk5NTIsIm5iZiI6MTc4NTc1OTY1MiwicGF0aCI6Ii83OTc1NTY4LzUyNDk5NjE5Ni01ZjM4OTQzMi1jZWZlLTRjNmMtODEzYi0xZjlmMDAzNWI1ZmQud2VicD9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA4MDMlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwODAzVDEyMjA1MlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTQ5YWM1OTdjNzgwNjY0ZGMzZTVlMjExNjg4ZTU5ZTkwMDIzMTAyMjgxZjA3NmI2ZWZmZjA2MTkwMDQwNWY5MGMmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JnJlc3BvbnNlLWNvbnRlbnQtdHlwZT1pbWFnZSUyRndlYnAifQ.KoiBbxxRypGdjsnaoTGlnr6a555FoWkSaLabyG5upk4) 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://lab.getkirby.com/public/lab/basics/icons/1_iconset) 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. Panel buttons and icons ----------------------- [](#panel-buttons-and-icons) To make your documentation match what clients actually see, you can drop `` and `` straight into your articles. They render as the real Panel buttons and icons, reusing Kirby's own styles and icon set, so they always look like the real thing. ### Buttons [](#buttons) ``` Save ``` Because they render as Kirby's own buttons, the [Kirby Lab](https://lab.getkirby.com) is the live, visual reference for the icons, themes, variants and sizes you can use. All attributes are optional: - `icon` – any icon name from the [icon set](https://lab.getkirby.com/public/lab/basics/icons/1_iconset) - `theme` – a button [theme](https://lab.getkirby.com/public/lab/components/buttons/2_themes) like `positive`, `negative`, `info` or `notice`. For page status buttons use the `-icon` variants: `negative-icon` (draft), `info-icon` (unlisted), `positive-icon` (listed). - `variant` – [`filled`](https://lab.getkirby.com/public/lab/components/buttons/1_variants) (default) or `dimmed` - `size` – [`xs`, `sm`, `md`, `lg`](https://lab.getkirby.com/public/lab/components/buttons/3_sizes) (default `md`) - `link` – turns the button into a link. Reference a file in the article's folder by name (e.g. `link="template.zip"`), just like the `(image:)` and `(file:)` tags. Relative URLs (e.g. `/panel/site`), `mailto:`, `tel:` and external links also work; external links open in a new tab. - `download` – on a button that links to a file, saves it under its original filename instead of opening it in the browser - `title` – accessible label for an icon-only button, e.g. `` (matches Kirby's `k-button`; not needed when there's visible text) Ideally put buttons on their own line. Avoid placing one in the middle of a sentence – a button is taller than your text and will disrupt the line height. ``` Add Delete ``` ### Icons [](#icons) Icons are inline and decorative by default (`aria-hidden`). When an icon carries meaning, add `alt` so screen readers announce it: ``` Click the button to add a block. ``` Use any name from the [icon set](https://lab.getkirby.com/public/lab/basics/icons/1_iconset). Options ------- [](#options) ``` // site/config/config.php return [ 'medienbaecker.help-view' => [ 'root' => '/path/to/custom/help/folder' ] ]; ``` Notes ----- [](#notes) - The help menu item only appears if the `site/help` folder exists. - Help articles are trusted content (like your templates) – any HTML in them is rendered as-is. 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 43 — FairBetter than 89% of packages Maintenance87 Actively maintained with recent releases Popularity25 Limited adoption so far Community12 Small or concentrated contributor base Maturity40 Maturing project, gaining track record Bus Factor1 Top contributor holds 87.5% 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 ~32 days Recently: every ~42 days Total 7 Last Release 54d 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 (14 commits)")[![danburzo](https://avatars.githubusercontent.com/u/205375?v=4)](https://github.com/danburzo "danburzo (1 commits)")[![timnarr](https://avatars.githubusercontent.com/u/3532570?v=4)](https://github.com/timnarr "timnarr (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 [getkirby/cms The Kirby core 1.5k606.6k541](/packages/getkirby-cms)[medienbaecker/kirby-modules Easily add modules to your pages 895.6k1](/packages/medienbaecker-kirby-modules)[getkirby/starterkit Kirby Starterkit 20413.9k](/packages/getkirby-starterkit)[getkirby/plainkit Kirby Plainkit 11911.9k1](/packages/getkirby-plainkit)[pechente/kirby-password-guard Kirby Password Guard 386.5k](/packages/pechente-kirby-password-guard)[grommasdietz/kirby-blueprint-areas Add custom Panel areas via blueprints on Kirby CMS 211.4k](/packages/grommasdietz-kirby-blueprint-areas) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)