Readme Viewer
This project provides an easy way to view README documentation for all installed modules and themes directly within your Drupal site. It adds a tab to the modules administration page, allowing you to quickly find and read module documentation without leaving your browser. The tool supports multiple file formats and renders Markdown nicely, offering a convenient alternative to searching through file directories.
README Viewer provides a convenient, user-friendly interface to view README files from all installed modules and themes directly within your Drupal site.
Why Use README Viewer?
Stop hunting through your file system or module directories to read documentation. README Viewer brings all your module documentation together in one place, accessible right from the Extend page.
Key Features
- Integrated Tab: Adds a "README Files" tab on /admin/modules alongside the Extend and Uninstall tabs
- Complete Coverage: Automatically discovers README files from all installed modules and themes (contrib, custom, and core)
- Smart Search: Live filtering to quickly find modules by name, type, or status
- Status Indicators: Clearly shows which modules are enabled or disabled
- Multiple Formats: Supports README.md, README.txt, and README files
- Beautiful Rendering: Renders Markdown files with proper formatting when league/commonmark is installed
- Modal Viewer: Opens README files in convenient AJAX modal dialogs
- Performance Optimized: Caches scan results with manual refresh option
- No Configuration: Works out of the box - just enable and use
Perfect For
- Site builders who want quick access to module documentation
- Developers reviewing module capabilities before configuration
- Teams onboarding new developers to understand installed modules
- Anyone tired of switching between browser and file system to read README files