通过 
搜索
搜索schmunk42 / yii2-markdocs-module
将本地文件夹中的markdown文件渲染为视图
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
- 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-08-27 18:06:35 UTC
README
在视图中渲染从URL或本地文件中的markdown文件。
您可以选择以自定义主题优雅地显示在线GitHub仓库的文档。或者从本地文件提供后端应用程序文档。
需求
- 已配置
pheme/yii2-settings模块和组件 - 已配置 RBAC 访问控制，权限:
docs_default
安装
安装此扩展的首选方法是通过 composer。
运行
composer require schmunk42/yii2-markdocs-module "*"
配置
用法
配置
通过 设置 模块
部分: <module-id>
键
markdownUrlforkUrldefaultIndexFilecachingTime
键也可以用模式键前缀，例如 guide.markdownUrl，并通过URL参数 docs/?schema=guide 选择，这样您可以在单个模块中包含多个文档。
渲染Markdown markdocs/default
可以渲染本地文件或URL中的原始数据。
渲染API文档 markdocs/html
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