level51/silverstripe-markdown-docs

后端 Markdown 文档查看器。

安装: 61

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 0

开放问题: 0

类型:silverstripe-module

0.1.1 2018-06-10 00:00 UTC

This package is auto-updated.

Last update: 2024-08-24 21:17:12 UTC


README

在后台提供简单的只读 Markdown 文档查看器。

Markdown Docs Demp Screenshot

功能

  • 使用 Parsedown 的力量渲染 Markdown 文档
  • 权限系统集成,以控制谁可以查看文档
  • 配置 API 集成

安装

composer install level51/silverstripe-markdown-docs

配置

# config.yml
MarkdownDocs:
  transform_names: true # e.g. CHANGELOG --> Changelog (default: true)
  docs:
    - CHANGELOG.md
    - manual:
        name: User Manual
        path: 'my-module/docs/en/backend-user-manual.md' # Path from site root

成员需要拥有 CMS_ACCESS_MarkdownDocs 权限(见“CMS 访问”权限类别)才能查看文档。

维护者