PHPackages                             schmunk42/yii2-markdocs-module - 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. [Templating & Views](/categories/templating)
4. /
5. schmunk42/yii2-markdocs-module

ActiveYii2-extension[Templating & Views](/categories/templating)

schmunk42/yii2-markdocs-module
==============================

Renders markdown files from local folder as views

1.2.0(5mo ago)867.0k—8.3%41BSD-3-ClausePHP

Since Jan 26Pushed 5mo ago3 watchersCompare

[ Source](https://github.com/schmunk42/yii2-markdocs-module)[ Packagist](https://packagist.org/packages/schmunk42/yii2-markdocs-module)[ RSS](/packages/schmunk42-yii2-markdocs-module/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (4)Dependencies (3)Versions (26)Used By (1)

yii2-markdocs-module
====================

[](#yii2-markdocs-module)

Renders markdown files from URLs or local files in views.

You can either display the documentation of your online GitHub repo nicely rendered in a custom theme. Or provide application documention in the backend from local files.

Requirements
------------

[](#requirements)

- configured `pheme/yii2-settings` module and component
- configured RBAC access control, permission: `docs_default`

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

[](#installation)

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

Run

```
composer require schmunk42/yii2-markdocs-module "*"

```

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

[](#configuration)

Usage
-----

[](#usage)

### Configuration

[](#configuration-1)

Via **Settings** module

Section: ``

Keys

- `markdownUrl`
- `forkUrl`
- `defaultIndexFile`
- `cachingTime`

Keys can also be prefixed with a schema key, eg `guide.markdownUrl` and selected via URL parameter `docs/?schema=guide`, so you can include multiple documentations within a single module.

### Render Markdown `markdocs/default`

[](#render-markdown-markdocsdefault)

Can render local files or raw data from an URL.

### Render API documentation `markdocs/html`

[](#render-api-documentation-markdocshtml)

Example command for `dmstr/phd5-app`

```
$ php -dmemory_limit=512M vendor/bin/apidoc api \
    --template=online \
    --exclude=yiisoft,Test,Tests,test,tests,ezyang,phpdocumentor,nikic,php_codesniffer,phptidy,php-cs-fixer,faker \
    src/,vendor/ \
    runtime/html

```

---

#### [![dmstr logo](https://camo.githubusercontent.com/4a62a35a7eb620fd4540cbaa6712caa42674aa6619344ec3e37460aa1225bd01/687474703a2f2f742e7068756e64616d656e742e636f6d2f646d7374722d31362d63726f707065642e706e67)](https://camo.githubusercontent.com/4a62a35a7eb620fd4540cbaa6712caa42674aa6619344ec3e37460aa1225bd01/687474703a2f2f742e7068756e64616d656e742e636f6d2f646d7374722d31362d63726f707065642e706e67) Built by [dmstr](http://diemeisterei.de)

[](#-built-by-dmstr)

###  Health Score

53

—

FairBetter than 97% of packages

Maintenance73

Regular maintenance activity

Popularity36

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity73

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

Recently: every ~665 days

Total

20

Last Release

153d ago

Major Versions

0.4.0 → 1.0.0-beta12018-08-31

### Community

Maintainers

![](https://www.gravatar.com/avatar/3b4ab2b6685ec71887908ec8cff261a16cd5bb24c69bb8ab52840e220f175f9d?d=identicon)[schmunk](/maintainers/schmunk)

---

Top Contributors

[![schmunk42](https://avatars.githubusercontent.com/u/649031?v=4)](https://github.com/schmunk42 "schmunk42 (39 commits)")

---

Tags

yii2extension

### Embed Badge

![Health badge](/badges/schmunk42-yii2-markdocs-module/health.svg)

```
[![Health](https://phpackages.com/badges/schmunk42-yii2-markdocs-module/health.svg)](https://phpackages.com/packages/schmunk42-yii2-markdocs-module)
```

###  Alternatives

[raoul2000/yii2-bootswatch-asset

Use Bootswatch theme in your Yii application with minimum effort

2145.0k4](/packages/raoul2000-yii2-bootswatch-asset)[zxbodya/yii2-tinymce

Yii2 extension to use TinyMce with Compressor and FileManager

1732.1k3](/packages/zxbodya-yii2-tinymce)

PHPackages © 2026

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