level51 / silverstripe-markdown-docs
Backend markdown document viewer.
Installs: 61
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Type:silverstripe-module
Requires
- php: >=5.6,<7.2
- erusev/parsedown: 1.7.1
- silverstripe/framework: ^3.6.0
This package is auto-updated.
Last update: 2024-10-24 21:40:35 UTC
README
Provides a simple readonly markdown document viewer in the backend.
Features
- Renders markdown documents with the power of Parsedown
- Permission system integration to control who can view the documents
- Config API integration
Installation
composer install level51/silverstripe-markdown-docs
Config
# 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
The member needs to have the CMS_ACCESS_MarkdownDocs
permission (see "CMS Access" permission category) to view the documents.
Maintainer
- JZubero js@lvl51.de