PHPackages trendyminds/statamic-guide - 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. trendyminds/statamic-guide ActiveLibrary[Utility & Helpers](/categories/utility) trendyminds/statamic-guide ========================== An in-control-panel guide that helps content editors find their way around Statamic 1.0.0(today)00MITPHPPHP ^8.3 Since Jun 27Pushed todayCompare [ Source](https://github.com/trendyminds/statamic-guide)[ Packagist](https://packagist.org/packages/trendyminds/statamic-guide)[ RSS](/packages/trendyminds-statamic-guide/feed)WikiDiscussions main Synced today READMEChangelog (1)Dependencies (2)Versions (2)Used By (0) πŸ“” Statamic Guide ================ [](#-statamic-guide) An in-control-panel guide that helps content editors find their way around your Statamic website. It adds a **Guide** section to the control panel navigation, built entirely from markdown files you define in your project so every site can document its own collections, blocks, workflows, and quirks. Installation ------------ [](#installation) ``` composer require trendyminds/statamic-guide ``` The addon auto-registers via package discovery, and its compiled control panel assets are published to `public/vendor/statamic-guide` automatically by Statamic's `statamic:install` hook. Defining your guide ------------------- [](#defining-your-guide) Your guide is built from markdown files in your project. The addon reads them from `resources/guide`: ``` resources/guide/ β”œβ”€β”€ index.md # the "Guide" landing page (optional) β”œβ”€β”€ assets.md β”œβ”€β”€ blocks.md └── collections.md ``` - **`index.md`** becomes the landing page shown when you click "Guide" in the nav. If it's omitted, the landing page lists the other pages automatically. - **Every other `.md` file** becomes a child page under "Guide", listed alphabetically by title. - **Titles** are derived from the filename (`seo-pro.md` β†’ "Seo Pro") but can be set explicitly via front matter. ### Front matter [](#front-matter) Each file may include optional YAML front matter: ``` --- title: SEO Pro --- SEO Pro is an addon used to manage your website's SEO information… ``` KeyDescription`title`Nav label and page heading. Defaults to a title-cased filename.The page's URL slug is always derived from its filename (`seo-pro.md` β†’ `seo-pro`). ### Blade & Antlers in markdown [](#blade--antlers-in-markdown) Guide files are rendered through **Blade and then Markdown**, so you can use Laravel helpers, Blade directives, and even Antlers right inside your content: ``` ## Logging in - **CMS Login:** [{{ url(config('statamic.cp.route')) }}]({{ url(config('statamic.cp.route')) }}) - **Username:** {{ Auth::user()->email }} ![Dashboard]({{ asset('img/guide/dashboard.png') }}) ``` > Because content is compiled by Blade, wrap any literal `@`, `{{ }}`, or example code that should *not* be evaluated in `@verbatim … @endverbatim`. Reference your own images however you like β€” e.g. files you place in the app's `public` directory. How it renders -------------- [](#how-it-renders) Guide pages are rendered as a Vue page component through Statamic 6's Inertia-powered control panel, so navigating between pages feels instant and consistent with the rest of the CP. Markdown is purely the **data layer**: on each request the addon reads the relevant `.md` file, compiles it (Blade β†’ Markdown) into HTML on the server, and passes that HTML to the Vue component as a prop. **Adding, editing, or removing markdown files never requires a rebuild** β€” only changes to the addon's own JavaScript do. Development ----------- [](#development) The compiled control panel assets are committed under `resources/dist`, so installing the addon via Composer just works β€” there's nothing for consumers to build. If you change the addon's JavaScript (`resources/js`), iterate with the Vite dev server for hot module replacement: ``` composer install # provides @statamic/cms for the npm build npm install npm run dev # Vite dev server with HMR ``` When you're done, build the production assets and commit the output so Composer installs work with no build step: ``` npm run build # outputs resources/dist ``` License ------- [](#license) MIT ### Health Score 40 β€” FairBetter than 86% of packages Maintenance100 Actively maintained with recent releases Popularity0 Limited adoption so far Community6 Small or concentrated contributor base Maturity48 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 Unknown Total 1 Last Release 0d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/51ee860b8a11c81c32b2d0bf9f90e23067fcf3cf72476bfab89913bf0e1ea3b3?d=identicon)[trendyminds](/maintainers/trendyminds) --- Top Contributors [![aaronbushnell](https://avatars.githubusercontent.com/u/315202?v=4)](https://github.com/aaronbushnell "aaronbushnell (3 commits)") ### Code Quality Code StyleLaravel Pint ### Embed Badge ![Health badge](/badges/trendyminds-statamic-guide/health.svg) ``` [![Health](https://phpackages.com/badges/trendyminds-statamic-guide/health.svg)](https://phpackages.com/packages/trendyminds-statamic-guide) ``` ### Alternatives [statamic/seo-pro 68488.6k](/packages/statamic-seo-pro)[statamic-rad-pack/runway Eloquently manage your database models in Statamic. 135212.4k7](/packages/statamic-rad-pack-runway)[statamic/ssg Generate static sites with Statamic. 254319.5k](/packages/statamic-ssg)[rias/statamic-redirect 29322.9k](/packages/rias-statamic-redirect)[spatie/statamic-responsive-images Responsive Images for Statamic 114250.6k](/packages/spatie-statamic-responsive-images)[marcorieser/statamic-livewire A Laravel Livewire integration for Statamic. 23100.9k12](/packages/marcorieser-statamic-livewire) PHPackages Β© 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)