Egenverk Docs Viewer · Documentation

Getting started

v2.7.0WP 5.0+PHP 7.4+Updated

Docs Viewer shows the README, CHANGELOG and docs/ files of your installed plugins and themes in a reader inside wp-admin.

Requirements

  • WordPress 5.0 or later
  • PHP 7.4 or later

Install

  1. Install the plugin from Plugins → Add New, or upload the egenverk-docs-viewer folder to wp-content/plugins/.
  2. Activate Egenverk Docs Viewer from the Plugins screen.

First step

Open Tools → Docs Viewer and click Scan for docs. The plugin scans plugins, themes and must-use plugins and shows the documents in a file tree with Preview and Raw tabs.

The index updates itself when plugins or themes are installed, updated or deleted, and when plugins are activated or deactivated. Run Scan for docs again after changing files outside WordPress, for example over FTP or git. By default only users with the manage_options capability can see the documents, which means administrators.

Resources