README
Component ID
2696135
Component name
README
Component type
module
Maintenance status
Development status
Component security advisory coverage
not-covered
Downloads
1641
Component created
Component changed
Component body
Introduction
Allows site builders and administrator to view a module's README file.
Features
-
Adds link to a module's README file from Drupal's Extend page (/admin/modules)
-
Converts a module's README.md (Markdown) file to HTML.
-
Provides a
drush readme-exportcommand that converts a contrib module's README.md (MarkDown) file to clean HTML that can be uploaded to a contrib module's project page.
Installation
For MarkDown support you must either....
-
Use Composer :composer require drupal/readme
Composer will install the github package as well. Or -
Manually, place the contents from https://github.com/michelf/php-markdown into /libraries/markdown.