PHPackages                             petrleocompel/yii2-markdown-docs - 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. petrleocompel/yii2-markdown-docs

AbandonedArchivedYii2-extension

petrleocompel/yii2-markdown-docs
================================

Yii2 markdown documentation module

1211PHP

Since Oct 15Pushed 9y ago1 watchersCompare

[ Source](https://github.com/petrleocompel/yii2-markdown-docs)[ Packagist](https://packagist.org/packages/petrleocompel/yii2-markdown-docs)[ RSS](/packages/petrleocompel-yii2-markdown-docs/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

Yii2 Markdown docs
==================

[](#yii2-markdown-docs)

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

[](#installation)

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

Either run

```
php composer.phar require --prefer-dist petrleocompel/yii2-markdown-docs "*"

```

or run

```
composer require petrleocompel/yii2-markdown-docs

```

or add

```
"petrleocompel/yii2-markdown-docs": "*"

```

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

Configuration
-------------

[](#configuration)

Enable the module in your confguration:

```
'modules' => [
    'docs' => [
        'class' => 'petrleocompel\yii2\markdowndocs\Module',
        // You can set custom parserClass
        //'parserClass' => 'cebe\markdown\GithubMarkdown'
        'skipFirstHeading' => false, // if you want to skip rendering of first heading
    ],
],

```

### Routing

[](#routing)

Add a rule to your url manager component:

```
'urlManager' => [
    'enablePrettyUrl' => true,
    'showScriptName'  => false,
    'rules' => [
        ...
        [
            'pattern'      => 'doc',
            'route'        => 'doc/default/view',
            'encodeParams' => false
        ],
        ...
    ],
],

```

Your documentation would then be accessible under your application's `/doc` URL.

> You can change this url but if your `@app` is your `@webroot` then if you will change it to `/docs` there could be collision.

So for compatibility i recommend to use `/doc`

Usage
-----

[](#usage)

This module assumes your documentation lives under the `@app/docs` alias.

### Make doc

[](#make-doc)

Under `@app/docs` you should make your md files. You dont have to create listing its automatic.

#### Titles of doc

[](#titles-of-doc)

On every 1 line of file should be `#` means Heading 1

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 70% 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/8941cbee7c81a6253dc1681a4a2412abf928b85cacea465188d309219e504131?d=identicon)[petrleocompel](/maintainers/petrleocompel)

---

Top Contributors

[![petrleocompel](https://avatars.githubusercontent.com/u/9423543?v=4)](https://github.com/petrleocompel "petrleocompel (7 commits)")[![jasonhancock](https://avatars.githubusercontent.com/u/1113245?v=4)](https://github.com/jasonhancock "jasonhancock (3 commits)")

### Embed Badge

![Health badge](/badges/petrleocompel-yii2-markdown-docs/health.svg)

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

PHPackages © 2026

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