• Stars
    star
    179
  • Rank 212,814 (Top 5 %)
  • Language
    PHP
  • License
    Mozilla Public Li...
  • Created almost 10 years ago
  • Updated 8 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A wiki in a box

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)

Stay up-to-date! RSS feed GitHub Releases (Don't forget you can watch releases too)

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

Website

Real World Usage

Is your site using Pepperminty Wiki? Contact me or open an issue and tell me about where you are using Pepperminty Wiki and I'll add you to this section 😺

Pepperminty Wiki has also been mentioned in a few places:

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 (dev license requires £££).
      • 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 done, as of v0.21!
  • Theme gallery (#5 - coming soon in v0.20!) done, as of v0.20-beta1
  • Self-service user registration (#181)
  • Packaging for sandstorm / Nextcloud?
  • Some kinda fancier (markdown) editor maybe
  • (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!

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

Security

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.

If you would like to encrypt any communications with me, you can find my GPG key here.

Contributing

Contributions are very welcome - both issues and pull requests! Please mention in your pull request that you release your work under the MPL-2.0 (see below).

If you're feeling that way inclined, the sponsor button at the top of the page (if you're on GitHub) will take you to my Liberapay profile if you'd like to donate to say an extra thank you :-)

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.

More Repositories

1

soundbox

🔈 🎶 A super simple JS library for playing sound effects 🎧 🎹
JavaScript
40
star
2

Nibriboard

🖼 An infinite whiteboard for those big ideas. Currently unstable and in alpha.
C#
18
star
3

Minetest-WorldEditAdditions

Extra tools and commands to extend WorldEdit for Minetest
Lua
16
star
4

msteams-profile

Shell script to manage multiple Microsoft Teams profiles on Linux.
Shell
10
star
5

twitter-academic-downloader

Anonymising tweet downloader that uses the Twitter Academic API full-archive search
JavaScript
7
star
6

bloworm

A self hosted bookmark storage system
PHP
6
star
7

shunction

Self-hosted Azure Functions implemented in pure bash
Shell
5
star
8

thebigwarehouse

A collection of resources for programmers
5
star
9

noisebox

A command line tool to generate random noise
C#
4
star
10

TraceRoutePlus

A traceroute utility written in C#. MOVED TO GITLAB
4
star
11

Pepperminty-Wiki-Client-Android

🔧 WIP 🔧 An experimental Pepperminty Wiki client, written in Kotlin for Android.
Kotlin
4
star
12

EmbedBox

Syntax-highlighted code embed generator
PHP
3
star
13

skyliner

Universal document outlining engine. Generate an outline of any text-based document!
JavaScript
3
star
14

research-smflooding

Some of the code behind the paper "Real-time social media sentiment analysis for rapid impact assessment of floods" [working title]
Jupyter Notebook
3
star
15

Share2Fediverse

Simple static share page to share content to the Fediverse
JavaScript
3
star
16

simple-md5-digest

A simple pure-js implementation of DIGEST-MD5. Written for XMPP, but can be used elsewhere.
JavaScript
2
star
17

consulstatus

Simple public-facing consul-backed status page
PHP
2
star
18

university-timetable

A Node.js script to re-emit your University of Hull Timetable as an ical calendar.
JavaScript
2
star
19

nimrod-data-downloader

Data downloader for the 1km NIMROD rainfall radar data
JavaScript
2
star
20

hourgraph

Creates an SVG from a TOML definition of a time plan / gantt chart
JavaScript
2
star
21

GoosePlus

Meta search engine that lets you create your own custom !bangs - just like DuckDuckGo!
PHP
2
star
22

FactorioAssemblyLanguage

An assembly language that compiles to factorio circuit networks
JavaScript
2
star
23

minetest-floating_anchor

A floating anchor mod for minetest. Adds an item that, when used, places a floating anchor block at the player's position.
Lua
2
star
24

nautilus-thumbnailer-stl

Short shell script to convert stl → png via OpenSCAD and associated nautilus thumbnailer config files
Shell
1
star
25

woppleblox

A micro-blogging app with a focus on being lightweight, easy to setup / install, and open.
Rust
1
star
26

applause-cli

Super-duper lightweight no-dependency alternative to clap
JavaScript
1
star
27

GlidingSquirrel

A http + websockets server, implemented in C#. Originally built for the /r/dailyprogrammer hard challenge #322.
C#
1
star
28

Minetest-shroomlands

A better mushroom island biome for Minetest.
Lua
1
star
29

PolyFeed

Create Atom feeds for websites that don't support it
C#
1
star
30

SDI-Docker

Assessed coursework Dockerfile for the module 661982 Secure Digital Infrastructure at the University of Hull
JavaScript
1
star
31

Minetest-bamboo

A bamboo plant for minetest
Lua
1
star
32

powahroot

Client and server-side routing micro frameworks
JavaScript
1
star
33

research-smflooding-vis

Visualisations of the main smflooding research for outreach purposes
JavaScript
1
star
34

moondoc

Modern Lua API documentation generator
JavaScript
1
star
35

terrain50

Library for parsing Ordnance Survey Digital Elevation Model files
JavaScript
1
star
36

json2collectdmqtt

JSON to collectd MQTT message bridge
JavaScript
1
star
37

Prolog-Visualisation-Toolkit

A tool to visualise Prolog traces.
JavaScript
1
star
38

SvgWriter

Generic SVG image generation & shape manipulation library
JavaScript
1
star