README Help

This module in the first place is intended for developers. The main feature of the module is reflected in its name:

Forget about implementing hook_help() in your_module.module file. Just write a decent README file with all information required and see it looking almost the same both on the admin/help/your_module page as well in your text editor. No more hardly to read (and to write!) markup intermingled with an actual user help text. All that you need is just to add the readmehelp dependency in your_module.info.yml and spend a couple of minutes learning the basics of the markdown syntax.

Note that when you install the module then README.md file from the link above will look differently (better) on the module's help page. This is because on a Github repository we see just the markdown to markup converted but on a Drupal site the file is additionally processed by the PHP script. You may test it on a demo site:

http://simplytest.me/project/readmehelp

After installing the site and the module visit admin/help/readmehelp page.

For now the README.md, README.txt and README files in a module's root directory supported by default. Though any files within the Drupal installation could be used.

Another useful feature of the module is generation of highlighted snippets from the Drupal PHP files. All that you need is just to insert an easy configurable token in the desirable place of a file:

@PHPFILE: relative/or/absolute/path/to/file.php LINE:62 PADD:25 :PHPFILE@

After refreshing a page you'll see a PHP snippet from the specified file with the LINE in the middle having PADD lines above and under the LINE.

Incomplete list of modules having similar or related functionality:

Advanced help
Editor.md
Help Me
Markdown filter
README

Supporting organizations:

Put your name here...