Project Wiki
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.
The Project Wiki module implements an editable (typically site owner / builder / admin) wiki for your Drupal project.
The Project Wiki module implements an editable wiki for your project in order for you to keep track of a larger Drupal project's structure and functionality even after some time. With it and its submodules you can easily create your project's documentation using Drupal's UI or via Markdown files.
Features
With this module, you can:
- Manage a wiki for your Drupal page and/or project
- Create, edit and delete entries via Drupal's UI and/or Markdown files using Project Wiki's submodules
- Decide who is able to view and/or edit the wiki
- Easily search and filter for specific entries on the Project Wiki list page
You can also create your own submodule to provide specific content using Markdown that you can update remotely without needing to update specific content on multiple individual devices.
For help with this process, install the "Project Wiki Markdown Content Example" module and take a look at the provided entries about creating a Markdown submodule.
Post-Installation
It is important to note, that the "Project Wiki" module on its own does not provide a way to create or edit wiki contents. To do so, you must enable the appropriate submodules.
- After the installation of "Project Wiki":
- The Project Wiki list page, where you can view all wiki contents, will be available via the Admin Toolbar.
- You can change the permissions related to "Project Wiki" and any of the submodules at [People]→[Permissions].
- If the "Project Wiki Entity Content" submodule has been installed:
- Navigate to [Content]→[Project Wiki Entity] to create and manage entity contents.
- Navigate to [Structure]→[Manage Project Wiki Entity] to manage the entity content fields and displays.
- If the "Project Wiki Markdown Content" submodule has been installed:
- It is recommended to take a look at [Configuration]→[Project Wiki settings]→[Markdown Content Settings] to check settings regarding Markdown and HTML escaping.
Additional Requirements
This module requires the following modules / libraries:
- League Commonmark (Library)
- ListJS (Module / Library)
Some of these requirements need to be installed via Composer. For this, use:
composer require 'bower-asset/listjs'
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!
Let's make Drupal even better, together!