hook_help() : créer une page d'aide pour un module en Drupal 8

Pour développer de bons modules pérennes, il est important d'avoir des informations ou de la documentation sur le fonctionnement du module ou son installation. Pour enregistrer ces informations on implémente le hook_help(). Voyons comment on crée une page d'aide pour un module en Drupal 8. 

On part du principe qu'on crée un module qui s'appelle "mon_module".

A la racine du répertoire du module, dans le fichier "mon_module.module" on ajoute le hook_help() :

<?php

  use Drupal\Core\Routing\RouteMatchInterface;

  /** 
   * Implements hook_help()
   */
  function mon_module_help($route_name, RouteMatchInterface $route_match) {
    switch($route_name) {
      case 'help.page.mon_module':
        $output = '';
        $output .= '<h3>'. t('About') .'</h3>';
        $output .= '<p>'. t('Ce module permet :') .'</p>';
        $output .= '<ul>';
        $output .= '<li>'. t('- de faire cela') .'</li>';
        $output .= '<li>'. t('- mais aussi d\'ajouter cette fonctionnalité') .'</li>';
        $output .= '<li>'. t('- et celle ci') .'</li>';
        $output .= '</ul>';
        $output .= '<p>'. t('Le lorem ipsum est, en imprimerie, une suite de mots sans signification utilisée à titre provisoire 
        pour calibrer une mise en page, le texte définitif venant remplacer le faux-texte dès qu\'il est prêt ou que la mise en 
        page est achevée. Généralement, on utilise un texte en faux latin, le Lorem ipsum ou Lipsum.') .'</p>';

        return $output;

      default: 
    }
  }

Une fois le module "mon_module" installé on obtient le lien "Aide" dans la description du module :

et si on clique sur ce lien on tombe sur notre page d'aide :