schmunk42 / yii2-markdocs-module
Renders markdown files from local folder as views
Installs: 57 338
Dependents: 1
Suggesters: 0
Security: 0
Stars: 8
Watchers: 4
Forks: 4
Open Issues: 0
Type:yii2-extension
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
- dev-master
- 1.1.0
- 1.0.0
- 1.0.0-beta4
- 1.0.0-beta3
- 1.0.0-beta2
- 1.0.0-beta1
- 0.4.0
- 0.4.0-rc2
- 0.4.0-rc1
- 0.4.0-beta4
- 0.4.0-beta3
- 0.4.0-beta2
- 0.4.0-beta1
- 0.4.0-alpha2
- 0.4.0-alpha1
- 0.3.0
- 0.2.0
- 0.1.0
- 0.0.1
- dev-feature/schema-prefix
- dev-feature/js-toc
- dev-feature/assets
- dev-feature/develop-0.4
- dev-feature/settings
This package is auto-updated.
Last update: 2024-10-27 18:30:05 UTC
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-settingsmodule 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
markdownUrlforkUrldefaultIndexFilecachingTime
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