mirror of
https://github.com/sbrl/Pepperminty-Wiki.git
synced 2024-11-14 01:43:01 +00:00
81 lines
7 KiB
Markdown
81 lines
7 KiB
Markdown
#  Pepperminty Wiki [](https://travis-ci.org/sbrl/Pepperminty-Wiki) [](https://gitter.im/Pepperminty-Wiki/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://raw.githubusercontent.com/sbrl/Pepperminty-Wiki/master/LICENSE) [](https://hub.docker.com/r/sqlatenwiki/peppermintywiki)
|
|
|
|
> A Wiki in a box
|
|
|
|
Pepperminty Wiki is a complete wiki engine contained in a single file, inspired by @am2064's [Minty Wiki](https://github.com/am2064/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:** [](https://github.com/sbrl/Pepperminty-Wiki/releases/latest)   ([Changelog](https://github.com/sbrl/Pepperminty-Wiki/blob/master/Changelog.md))
|
|
|
|
Stay up-to-date! [](https://github.com/sbrl/Pepperminty-Wiki/releases.atom) [](https://github.com/sbrl/Pepperminty-Wiki/releases) (Don't forget you can watch releases too)
|
|
|
|
## Screenshot
|
|
[](https://imgur.com/a/lsBc3cM)
|
|
|
|
## 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](https://starbeamrainbowlabs.com/labs/peppermint/__nightdocs/01-Welcome.html)**
|
|
|
|
**[Website](https://peppermint.mooncarrot.space/)**
|
|
|
|
## Real World Usage
|
|
|
|
* [WikiProject Paranormal](https://www.anomalyresponse.com) - An encyclopedia of allegedly unexplained events.
|
|
|
|
Is your site using Pepperminty Wiki? Contact me or [open an issue](https://github.com/sbrl/Pepperminty-Wiki/issues/new) and tell me about where you are using Pepperminty Wiki and I'll add you to this section :smiley_cat:
|
|
|
|
Pepperminty Wiki has also been mentioned in a few places:
|
|
|
|
- [Twitter, by @flameborn](https://twitter.com/flameborn/status/1196916602953961472)
|
|
- [Reddit, by u/flameborn](https://www.reddit.com/r/selfhosted/comments/d23mhx/yet_another_wiki/ezsu4rs?utm_source=share&utm_medium=web2x)
|
|
- @SeanFromIT has written an article describing their experience migrating from MediaWiki: [MediaWiki to Pepperminty Wiki Migration](https://feeney.mba/mediawikitopepperminty.html)
|
|
|
|
## Todo
|
|
Here's a list of things that I want to add at some point (please feel free to [send a pull request](https://github.com/sbrl/Pepperminty-Wiki/pulls) 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](https://github.com/sbrl/Pepperminty-Wiki-Client-Android/)!
|
|
- Participate in the beta: https://play.google.com/apps/testing/com.sbrl.peppermint
|
|
- Report issues [here](https://github.com/sbrl/Pepperminty-Wiki-Client-Android/issues/new)
|
|
- 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](https://apps.sandstorm.io/) / [Nextcloud](https://apps.nextcloud.com/)?
|
|
- Some kinda fancier (markdown) editor maybe
|
|
- (See more on the [issue tracker](https://github.com/sbrl/Pepperminty-Wiki/issues)!)
|
|
- ...?
|
|
|
|
Is the feature you want to see not on this list or not implemented yet? [Open an issue](https://github.com/sbrl/Pepperminty-Wiki/issues/new) or [open a pull request](https://github.com/sbrl/Pepperminty-Wiki/pulls) - contributions welcome!
|
|
|
|
|
|
## Docker
|
|
The recommended way of running Pepperminty Wiki is with a plain PHP-enabled web server. However, a Dockerfile is available in this repository. Instructions for building it are available on the [Getting Started page](https://starbeamrainbowlabs.com/labs/peppermint/__nightdocs/04-Getting-Started.html#Docker) in the official documentation (see above).
|
|
|
|
|
|
## Security
|
|
If you've found a security issue, please don't open an issue. Instead, get in touch privately - e.g. via 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](https://starbeamrainbowlabs.com/sbrl.asc).
|
|
|
|
|
|
## 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).
|
|
|
|
See [CONTRIBUTING.md](./CONTRIBUTING.md) for a guide on what to expect when submitting a pull request or issue to this project.
|
|
|
|
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](https://liberapay.com/sbrl) 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](https://tldrlegal.com/license/mozilla-public-license-2.0-(mpl-2)) of the license if you're interested.
|