PHPackages                             miolae/yii2-markdown-doc - 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. [Parsing & Serialization](/categories/parsing)
4. /
5. miolae/yii2-markdown-doc

ActiveYii2-module[Parsing & Serialization](/categories/parsing)

miolae/yii2-markdown-doc
========================

Yii2 module to write documentation with MarkDown files

2.0.6(6y ago)15.8k↓47.5%[1 issues](https://github.com/viktorprogger/yii2-markdown-doc/issues)[1 PRs](https://github.com/viktorprogger/yii2-markdown-doc/pulls)MITPHPPHP >=5.6

Since Nov 23Pushed 6y ago1 watchersCompare

[ Source](https://github.com/viktorprogger/yii2-markdown-doc)[ Packagist](https://packagist.org/packages/miolae/yii2-markdown-doc)[ Docs](https://github.com/miolae/yii2-markdown-doc)[ RSS](/packages/miolae-yii2-markdown-doc/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (6)Dependencies (4)Versions (10)Used By (0)

yii2-markdown-doc
=================

[](#yii2-markdown-doc)

Yii2 module to display the content of all markdown file in a directory and its sub-folder.

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

[](#installation)

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

Either run

```
php composer.phar require --prefer-dist "miolae/yii2-markdown-doc" "2"

```

or add

```
"miolae/yii2-markdown-doc": "2"

```

to the require section of your `composer.json` file.

Configure
---------

[](#configure)

1. Configure the module in **config/web.php** as follows

```
'modules' => [
    //////////////////
    'doc'  => [
        'class' => 'miolae\yii2\doc\Module',
        // Directory to list
        'rootDocDir' => '@app/docs',
        // set false if you don't want to cache generated html, useful for debugging
        'cache' => true,
        // Prefix for browser title, i.e: Documentation: Page Title
        'titlePrefix' => 'Documentation:',
    ],
    //////////////////
],
```

1. Add `miolae\yii2\doc\controllers\DefaultController` either to `controllerMap` or to `urlManager`. Example for url manager with pretty url enabled:

```
'urlManager' => [
    'enablePrettyUrl' => true,
    'showScriptName'  => false,
    'rules'           => [
        '/doc/' => 'doc/default/index',
        '/doc'                   => 'doc/default/index',
    ],
],
```

Usage
-----

[](#usage)

1. Add `README.md` to your `docs` directory (or other one you specified in `rootDocDir` option)
2. To access the doc, go to

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance0

Infrequent updates — may be unmaintained

Popularity24

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity64

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

Recently: every ~163 days

Total

8

Last Release

2357d ago

Major Versions

0.0.1 → 1.0.02018-02-19

1.0.1 → 2.0.02018-02-20

### Community

Maintainers

![](https://www.gravatar.com/avatar/10acad9038a7b3af2d70f9404bdd4e377bbeb4214277a7cf61ae6fe9884988e6?d=identicon)[miolae](/maintainers/miolae)

---

Top Contributors

[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (30 commits)")

---

Tags

docmarkdownyii2

###  Code Quality

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/miolae-yii2-markdown-doc/health.svg)

```
[![Health](https://phpackages.com/badges/miolae-yii2-markdown-doc/health.svg)](https://phpackages.com/packages/miolae-yii2-markdown-doc)
```

###  Alternatives

[kartik-v/yii2-markdown

Advanced Markdown editing and conversion utilities for Yii Framework 2.0

88265.8k6](/packages/kartik-v-yii2-markdown)

PHPackages © 2026

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