Drupal 9 test page with open inline documentation panel.
Drupal 9 test page with open inline documentation panel.

Add and view documentation in realtime on pages. Alternative names for this module could be "Contextual Documentation" or "Realtime Documentation" but inline has a nice ring to it and matches the way documentation is placed in code.

This module will create a content type "Inline Documentation" and add a round blue button to the bottom right corner of every page. This button toggles a panel containing a list of the inline documentation nodes.

Documentation is the key for easy maintenance or project transferring. However, no one likes to write documentation and no one likes to read documentation.

Inline documentation tries to ease the load of writing documentation simply by allowing the user to add short bits of documentation directly to the webpage where the reader needs it. This decreases the need for extensive Wiki pages and Word documents.

Navigate to the page in question, click the 'Add documentation' button and start writing some docs. It's recommended to keep these docs short and simple, you can add as many as you like to a page and you can even attach them to DOM elements.

Project information

Releases