markdown_docs

Markdown Docs lets you publish a folder of Markdown files as browsable documentation pages inside the Drupal administration interface.

It is a lightweight solution for teams that already maintain internal guides, editor manuals, onboarding notes, or technical documentation in Markdown and want to make that content available directly in Drupal.

Features

• Renders Markdown files as admin documentation pages
• Adds a documentation landing page at /admin/documentation
• Builds navigation automatically from your documentation folder structure
• Uses the first H1 in each file as the page title
• Rewrites relative .md links to internal Drupal documentation routes
• Rewrites relative image paths to a secure image route
• Provides Ajax-powered search across documentation files
• Generates a table of contents from page headings
• Includes support for styled warning and tip callouts
• Falls back to an auto-generated overview page when no index.md exists

Typical use cases

• Editorial manuals
• Content governance documentation
• Internal support documentation
• Administrator handover notes
• Project-specific implementation guides

Requirements

• Drupal 8, 9, or 10
• league/commonmark

Configuration

The module reads Markdown files from a configurable documentation directory. By default it looks for:

documentation/

You can change this through the module configuration:

docs_path: documentation

Expected structure

Example:

documentation/
  index.md
  editors/
    getting-started.md
    publishing.md
  admins/
    users.md

• index.md becomes the landing page
• each subdirectory becomes a navigation section
• each Markdown file becomes a documentation page

Permissions

The module provides the access markdown_docs permission to control access to the documentation area.

Why use this module?

Many teams already write documentation in Markdown because it is portable, versionable, and easy to maintain in Git. Markdown Docs brings that content into Drupal without requiring a custom content model, extra editorial workflows, or manual page creation.

If your project documentation lives in the repository, this module makes it accessible to administrators and editors where they actually need it: inside Drupal.