Pepperminty Wiki is a complete wiki engine contained in a single PHP file. You drop that file on any PHP-capable web server, open it in a browser, and a first-run wizard writes the configuration for you. Pages are Markdown files in a directory, the page index is rebuilt from those files if it is missing or deleted, and the whole feature set is delivered by modules you can switch on or off. It is the kind of wiki you can hand to a small team or a personal project without provisioning a database, a runtime or a build pipeline.

Editing and pages

• Markdown-powered syntax via Parsedown Extra and Parsedown Extreme, with extra short syntax for referencing uploaded files, internal links, templates, and resizing or floating images.
• Subpages are fully supported, and internal links to pages that do not exist yet show up in red.
• Full page revision history, edit previewing, printable page view and simple edit-conflict detection.
• Page protection, threaded page comments, and page tags with lists of all pages, all tags, pages carrying a given tag, and recent changes.
• MathJax support as an optional extra for mathematical notation, plus file galleries for uploaded media.

Search

There is a full-text search engine with an advanced query syntax, dynamic server-side suggestions as you type, and an optional time-delayed search index. A plain search bar sits in the top navigation for quick lookups.

Configuration and extensibility

• Settings live in peppermint.json, with a GUI for moderators and a first-run wizard covering the basics.
• A user login system with a graphical user-management table for moderators, a settings page for changing your own password and email, and page protection by permission.
• Everything is module-based: features can be added or removed at will, and modules can extend the built-in help page, the statistics system and the API.
• Customisable themes with a theme gallery, an optional sidebar page tree, and configurable navigation links.
• An HTTP API and a PHP module API are documented, along with a command-line interface for maintenance tasks and a page index file (pageindex.json) you can inspect directly.

Installing and migrating

The recommended setup is a plain PHP-enabled web server; a Dockerfile also ships in the repository. Because the page index is rebuilt from the files in the content directory, an existing wiki directory can be dropped in and re-indexed — the project documents imports this way, and its link syntax is compatible with vimwiki. A companion Android client exists in a separate repository, and its interface is built to be screen-reader accessible.

Licence

MPL-2.0. Free and open source, with a file-level copyleft: you can combine it with differently licensed code, but modifications to MPL-covered files must stay under the MPL.

Alternatives

• Gollum — Git-backed wiki served by a Ruby gem
• TiddlyWiki — single-file wiki with a JavaScript client, no server-side PHP