Skip to main content
drupalreleases

Use direct release data with your AI assistant.

Learn more

Project Wiki

Security covered Under active development 22 sites

This module allows you to create and manage an editable wiki for your Drupal project to document its structure and functionality. You can create wiki entries through the Drupal UI or by using Markdown files with its submodules, and you control who can view and edit the content.

Project Wiki is an editable project-internal wiki inside your Drupal site.
It helps you keep track of a larger Drupal project's structure and functionality, even after some time. Additionally it allows to add notes on each admin page!

Write your project's documentation in Drupal's UI, ship it as Markdown files in your modules and themes, and attach notes to individual pages of your site.

Features

  • Wiki entries in the UI: revisionable entries with title, body, category and an optional "Developer content" flag. Revisions can be viewed, reverted and deleted, and every content type decides whether it creates new revisions by default.
  • The wiki page is a view: search, sort and filter by category at /admin/project-wiki, and adjust the view in the Views UI. Developer content is only shown to users with the matching permission.
  • Documentation as code: any module or theme can provide entries just by placing *.pwiki.md files in its docs folder, optionally organized by language and category. No PHP code or configuration needed. The files are indexed into content entities, so they can be queried with SQL and Views, and are kept in sync on every cache rebuild or with drush project-wiki:reindex.
  • Safe rendering: Markdown is rendered through a text format of your choice (default: Basic HTML) before it is stored.
  • Path notes: attach notes to any path of your site. They are shown in a block and, with the core Navigation module, in a top bar button. A recheck lists notes whose page was removed or redirected.
  • Fieldable: add your own fields to the content types with Field UI.

Submodules

Enable only what you need. The base module provides the permissions and the settings page, but no functionality on its own.

  • Project Wiki Entity Content: the wiki entries and the wiki page.
  • Project Wiki Markdown Content: indexes Markdown files of modules and themes into wiki entries.
  • Project Wiki Markdown Content Example: an example module providing Markdown entries, which you can copy for your own project.
  • Project Wiki Path Notes: notes for single pages of your site.

Getting started

  1. Install the module with Composer: composer require drupal/project_wiki
  2. Enable Project Wiki Entity Content, and Project Wiki Markdown Content if you want to provide entries as files.
  3. Grant the View Project Wiki permission to the roles that should read the wiki.
  4. Open /admin/project-wiki and create your first entry, or add a docs/entry.pwiki.md file to one of your modules and run drush cr.

The full documentation is in the README and on the help page of the module (/admin/help/project_wiki).

Requirements

Upgrading from 1.x

Run drush updb and drush cr. Existing entries become "manual" entries and the wiki page becomes a view. Project Wiki Content plugins (@ProjectWikiContent) are gone: provide *.pwiki.md files in the docs folder of a module or theme instead. The List.js library is no longer needed. See the README for details.

Recommended modules

  • Markdown: shows the help page formatted.
  • Redirect: path notes also detect redirected pages.
  • Navigation (core): adds the path notes button to the top bar.
  • Drush 12.5 or later: reindex Markdown files from the command line.

Similar and alternative modules

Project Wiki documents your own project inside the site that is being built. Depending on what you need, these modules may fit better or complement it:

Documentation and help

  • Help Topics (core): task-oriented help topics shipped as Twig files by modules. They are made for documenting a module's features, not for editing documentation of a specific site.
  • Advanced Help: modules and themes ship hierarchical help topics as HTML or Markdown files, like Project Wiki's Markdown files. It has no editable entries, revisions or Views integration, and is in maintenance-fixes-only mode.
  • Book (core): hierarchical, editable documentation made of nodes. It is a good fit for content-like manuals, while Project Wiki keeps its entries separate from your site content and can read documentation straight from your modules and themes.
  • Tour (core): step-by-step guided tours of single pages. They explain how to use a page; Project Wiki is a searchable knowledge base.
  • Annotations: attaches technical notes to entity types and fields. It documents the data structure only, and has no stable releases yet.
  • Wiki: a text filter with wiki syntax. It formats text, but does not provide a wiki with entries, search or revisions, and is only minimally maintained.

Notes on pages

  • Sticky Note, Sticky Notes and Admin Notes: block-based notes for single pages, similar to Project Wiki Path Notes. Path Notes adds a top bar button, a list of all notes and a check for notes of pages that were removed or redirected. Check the Drupal version support before you use the others.
  • Editor Notes and Entity Note Block: internal notes attached to an entity, not to a path. They fit editorial workflows; Path Notes also works for pages that are not entities, such as views and admin pages.

Support

Please report bugs and feature requests in the issue queue.

Additional Requirements

This module requires the following modules / libraries:

Furthermore, we suggest using the wonderful Gin Theme for best display.

Supporting this module

Support DROWL's ♥ FOSS work on this module on OpenCollective!

Drupal and this module are FOSS. However, it takes dedicated people to develop and maintain. And they need YOU to give back!

We're committed to building and maintaining Drupal modules that benefit the entire community.

Supporting us on OpenCollective helps us continue to improve, innovate and contribute to Drupal's future. Every pledge makes a difference!

If this module has helped you, we would be very grateful for your donation to support its further development and maintenance.

Support our FOSS development ♥️

You can also speed up the development of features or bugfixes you'd love to see, by sponsoring and giving back!

Sponsor a feature or bugfix 🚀

Let's make Drupal even better, together!

Ask your assistant about Project Wiki

Check compatibility with your Drupal and PHP version, maintenance and security coverage, from current release data. How it works

Depends on

Dependencies of the latest stable release

No dependencies recorded for this project.

Required by

Tracked projects that depend on this one

No tracked projects depend on this one yet.

Activity

Tracked releases
17
Tracked since
Jul 2023
Latest release
1 week ago
Releases (12 mo)
6 ▲ from 0
Maintenance
Active

Release Timeline

Releases

Version Type Core PHP Release date
2.0.0-alpha4 Pre-release 11 Nov 11, 2026
2.0.0-alpha3 Pre-release 11 Nov 11, 2026
2.0.0-alpha2 Pre-release 11 Oct 30, 2026
2.0.0-alpha1 Pre-release 11 Oct 29, 2026
2.x-dev Dev 11 Oct 29, 2026
1.0.0-beta10 Pre-release 10–11 Apr 1, 2026
1.0.0-beta9 Pre-release 10–11 Nov 11, 2024
1.0.0-beta8 Pre-release 10–11 Oct 14, 2024
1.0.0-beta7 Pre-release 10–11 Oct 13, 2024
1.0.0-beta6 Pre-release 10–11 Oct 11, 2024