PHPackages                             cmalven/guides - 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. cmalven/guides

ActiveCraft-plugin[Utility & Helpers](/categories/utility)

cmalven/guides
==============

An easy way to provide documentation in the Craft CMS control panel.

v1.0.3(8y ago)026MITPHP

Since Oct 26Pushed 8y agoCompare

[ Source](https://github.com/cmalven/guides)[ Packagist](https://packagist.org/packages/cmalven/guides)[ RSS](/packages/cmalven-guides/feed)WikiDiscussions master Synced 2w ago

READMEChangelog (4)Dependencies (1)Versions (5)Used By (0)

Guides plugin for Craft CMS
===========================

[](#guides-plugin-for-craft-cms)

An easy way to provide documentation in the Craft CMS control panel.

---

[![Screenshot](resources/screenshots/screenshot.jpg)](resources/screenshots/screenshot.jpg)

Features
--------

[](#features)

Everybody loves good documentation. Guides makes it easy to create, edit, and present top-notch documentation for your team and/or clients directly within the Craft control panel.

- Completely customize the appearance of your content by providing the path to a stylesheet.
- Create your content as honest-to-goodness native Craft channel entries using rich text or plain text (with Markdown).

Installation
------------

[](#installation)

To install Guides, follow these steps:

1. Download & unzip the file and place the `guides` directory into your `craft/plugins` directory
2. -OR- install with Composer via `composer require cmalven/guides`
3. Install plugin in the Craft Control Panel under Settings > Plugins
4. The plugin folder should be named `guides` for Craft to see it. GitHub recently started appending `-master` (the branch name) to the name of the folder for zip file downloads.

Guides works on Craft 2.4.x and Craft 2.5.x.

Setup
-----

[](#setup)

After installing Guides, there are a few additional steps you'll need to take in Craft to complete setup:

- Create a new `Channel` section with a handle of `guides` (this handle is customizable in the Guides plugin settings). `Entries in this section have their own URLs` *should not* be checked.
- Create a new field to use for your content. You can call this field whatever you want, but `Guide Content` is a good name. The field type should be one of the following:
    - `Plain Text` with `Allow line breaks` checked
    - `Rich Text`
- Add the field you just created to your `Guides` section.
- Create a new Guides entry, save it, then click *Guides* in the Craft sidebar nav. You should see your new content.

Customizing Content Styles
--------------------------

[](#customizing-content-styles)

Guides includes a `Stylesheet Path` setting that you can use to load a custom stylesheet (e.g. `dist/styles/guides.css`). This path is relative to your `siteUrl`. We recommend scoping all of your styles to a `.guide-plugin-content` selector to avoid overwriting any of Craft's default control panel styles.

###  Health Score

27

—

LowBetter than 46% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity66

Established project with proven stability

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 ~4 days

Total

4

Last Release

3202d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/13976264?v=4)[Marcus](/maintainers/malven)[@Malven](https://github.com/Malven)

---

Tags

craft-plugincraftcms

### Embed Badge

![Health badge](/badges/cmalven-guides/health.svg)

```
[![Health](https://phpackages.com/badges/cmalven-guides/health.svg)](https://phpackages.com/packages/cmalven-guides)
```

###  Alternatives

[helsingborg-stad/municipio

A bootstrap theme for creating municipality sites.

4028.6k10](/packages/helsingborg-stad-municipio)[mautic/core

Mautic Open Source Distribution

10.3k2.7k9](/packages/mautic-core)[mediawiki/maps

Adds various mapping features to MediaWiki

85155.1k3](/packages/mediawiki-maps)[starcitizentools/citizen-skin

A beautiful, usable, responsive MediaWiki skin with in-depth extension support. Originally developed for the Star Citizen Wiki.

3407.6k](/packages/starcitizentools-citizen-skin)[civicrm/civicrm-drupal-8

Open source constituent relationship management for non-profits, NGOs and advocacy organizations.

19256.6k4](/packages/civicrm-civicrm-drupal-8)[altis/core

Core module for Altis

19233.0k4](/packages/altis-core)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)