Skip to main content
Drupal is a registered trademark of Dries Buytaert
Release: OpenID Connect / OAuth client 3.0.0-alpha9 — New alpha version released for module openid_connect (3.0.0-alpha9). Usage Milestone: Google Analytics — Module google_analytics crossed 1,000 active installs. Release: Timelinr 1.0.1 — Minor update available for module timelinr (1.0.1). Release: GraphQL Compose Codegen 1.1.2 — Minor update available for module graphql_compose_codegen (1.1.2). Release: Mapy.com 1.1.3 — Minor update available for module mapycom (1.1.3). Release: Ckeditor5 entity browser 3.0.3 — Minor update available for module ckeditor5_entity_browser (3.0.3). Release: Ckeditor5 entity browser 3.0.1 — Minor update available for module ckeditor5_entity_browser (3.0.1). Release: Ckeditor5 entity browser 3.0.2 — Minor update available for module ckeditor5_entity_browser (3.0.2). Release: Teamleader Integration 4.0.2 — Minor update available for module teamleader (4.0.2). Module Revived: Entityqueue Buttons 1.1.2 — Module entityqueue_buttons updated after 8 months of inactivity (1.1.2).

Readme Viewer

No security coverage
View on drupal.org

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

Depends on

Dependencies of the latest stable release

No dependencies recorded for this project.

Required by

Tracked projects that depend on this one

No tracked projects depend on this one yet.

Activity

Tracked releases
3
Tracked since
Feb 2026
Latest release
6 months ago
Releases (12 mo)
3 ▲ from 0
Maintenance
Slowing

Release Timeline

Releases

Version Type Core Release date
1.0.0-alpha2 Pre-release 9–11 Feb 25, 2026
1.0.0-alpha1 Pre-release Feb 15, 2026
1.0.x-dev Dev Feb 15, 2026