This project is not covered by Drupal’s security advisory policy.
Allows site builders and administrator to view a module's README file anf other help files.
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.
Support status
Uncertain. It has been proposed to replace it with Advanced Help. See also #3204540: Obsolete this module and suggest that Advanced Help is used instead.
If you want to allow site builders and administrator to view a module's README file, you may install Advanced Help. It is believed that it provides the same service as this module.
Project information
Unsupported
Not supported (i.e. abandoned), and no longer being developed. Learn more about dealing with unsupported (abandoned) projectsObsolete
Use of this project is deprecated.5 sites report using this module
- Created by jrockowitz on , updated
This project is not covered by the security advisory policy.
Use at your own risk! It may have publicly disclosed vulnerabilities.




