schmunk42/yii2-markdocs-module

Renders markdown files from local folder as views

1.1.0 2023-02-27 15:08 UTC

Requires

• dmstr/yii2-emojifyjs-asset: ~0.1
• dmstr/yii2-mermaid-asset: ~0.0 || ^1.0
• dmstr/yii2-web: ~0.3 || ^0.4.0 || ^1.0.0
• yiisoft/yii2: 2.*

Suggests

• pheme/yii2-settings: Define markdocs module configuration via web UI

BSD-3-Clause

• Tobias Munk

• extension
• yii2

README

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

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

Installation

The preferred way to install this extension is through composer.

Run

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

Configuration

Usage

Configuration

Via Settings module

Section: <module-id>

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

Can render local files or raw data from an URL.

Render API documentation markdocs/html

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

Built by dmstr