Skip to content
PHP CSS Shell
Branch: master
Clone or download
Latest commit c63ea80 Sep 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
core Use tempnam() instead of tmpfile() when unpacking extra data Sep 11, 2019
docs Update making a release checklist Aug 28, 2019
lantern-build-engine @ 5cf2cfe
modules Add secret GET param to debug action Sep 11, 2019
themes Implement some theme update logic, but it's unfinished. Sep 1, 2019
.gitignore Ignore theme previews and theme index Aug 25, 2019
.gitmodules Seriously reorganise stuff. Much tidier :D Dec 12, 2018
.travis.yml Update PHP versions in Travis CI config Feb 1, 2019
Changelog.md Add credit to the changelog Sep 12, 2019
LICENSE Add license. Mar 24, 2016
README.md Add a bit to the README Sep 10, 2019
apidoc.json
build.php Add support for core sharding to build script Mar 2, 2019
build.sh Wire the theme index into the gallery ui, but it's still untested. Aug 26, 2019
composer.json Add luminous as a composer dependency, but it's not used yet Apr 25, 2019
download.php Fix line endings Oct 31, 2018
logo.png Optimise logo Aug 25, 2019
logo.svg Add logo Oct 28, 2017
module_index.json Add secret GET param to debug action Sep 11, 2019
nightdocs.toml Use nightdocs instead of docpress. May 12, 2019
pack.php Bugfix: Monkeypatch another crazy bug in the packing script Aug 29, 2019
package-lock.json
package.json Bump version & update changelog Aug 29, 2019
peppermint-config-info.php Update title of configuration guide page Aug 22, 2018
peppermint.guiconfig.json
version Bump version to v0.20-dev Aug 8, 2019

README.md

Pepperminty Wiki Logo Pepperminty Wiki Build Status Join the chat at https://gitter.im/Pepperminty-Wiki/Lobby License: MPL-2.0 Docker pulls count

A Wiki in a box

Pepperminty Wiki is a complete wiki engine contained in a single file, inspired by @am2064's Minty Wiki. It's open source too (under MPL-2.0), so contributions are welcome!

Developed by Starbeamrainbowlabs (though contributions from others are welcome!), Pepperminty Wiki has a variety of useful (and cool!) features - such as file upload, a dynamic help page, page revision history, page tags, and more! Other amazing features are in the works too (like a theme gallery, auto update, and user watchlists), so check the release notes to see what's been added recently.

Latest Version: stable version badge pre-release version badge development version badge (Changelog)

Screenshot

Main Page Example

Documentation

For everything you need to know (including how to get your own copy!), you probably want the documentation. It can be found here:

Documentation

Real World Usage

None yet! Contact me or open an issue and tell me about where you are using Pepperminty Wiki and I'll add you to this section 😺

Todo

Here's a list of things that I want to add at some point (please feel free to send a pull request and help out!).

  • Better page history (revert to revision done!, compare revisions, etc.) (#78, #79)
  • Intelligent auto-updating system that doesn't wipe your settings / module choices
  • A module registry of some sort (ideas welcome!)
  • Image maps (#103)
  • An app for Android - in progress over here!
    • Participate in the beta: https://play.google.com/apps/testing/com.sbrl.peppermint
    • Report issues here
    • An iOS app is not practical for the foreseeable future.
      • It's too expensive.
      • The ecosystem is very closed off, and I've no idea how to make an iOS app (nor do I own a device to test it on)
      • Feel free to make one yourself!
      • I'm happy to help out if you need help with Pepperminty Wiki itself (e.g. making it more machine-readable (#138))
      • Message on Gitter (see above), or open an issue on this repository.
  • User watchlists
  • Theme gallery (#5)
  • (See more on the issue tracker!)
  • ...?

Is the feature you want to see not on this list or not implemented yet? Open an issue or send a pull request - contributions welcome!

If you've found a security issue, please don't open an issue. Instead, get in touch privately - e.g. via Keybase or by email (security [at sign] starbeamrainbowlabs [replace me with a dot] com), and I'll try to respond ASAP.

Docker

The recommended way of running Pepperminty Wiki is with a plain PHP-enabled web server. However, a docker container is generously provided by @SQL-enwiki. You can run it like so:

docker run -d sqlatenwiki/peppermintywiki:stable

License

Pepperminty Wiki is released under the Mozilla Public License 2.0. The full license text is included in the LICENSE file in this repository. Tldr legal have a great summary of the license if you're interested.

You can’t perform that action at this time.