level51/silverstripe-markdown-docs

Backend markdown document viewer.

Installs: 60

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Type:silverstripe-module

0.1.1 2018-06-10 00:00 UTC

This package is auto-updated.

Last update: 2021-01-24 12:52:18 UTC


README

Provides a simple readonly markdown document viewer in the backend.

Markdown Docs Demp Screenshot

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