1
0
Fork 0
mirror of https://github.com/sbrl/Pepperminty-Wiki.git synced 2024-11-16 14:33:01 +00:00
Pepperminty-Wiki/README.md

54 lines
3.9 KiB
Markdown
Raw Normal View History

2017-10-28 16:21:52 +00:00
# ![Pepperminty Wiki Logo](https://raw.githubusercontent.com/sbrl/Pepperminty-Wiki/master/logo.png) Pepperminty Wiki [![Build Status](https://travis-ci.org/sbrl/Pepperminty-Wiki.svg?branch=master)](https://travis-ci.org/sbrl/Pepperminty-Wiki) [![Join the chat at https://gitter.im/Pepperminty-Wiki/Lobby](https://badges.gitter.im/Pepperminty-Wiki/Lobby.svg)](https://gitter.im/Pepperminty-Wiki/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![License: MPL-2.0](https://img.shields.io/badge/License-MPL--2.0-blue.svg)](https://raw.githubusercontent.com/sbrl/Pepperminty-Wiki/master/LICENSE)
2017-09-14 19:58:54 +00:00
> A Wiki in a box
2015-09-19 09:19:56 +00:00
2018-12-12 22:26:13 +00:00
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!
2015-09-19 09:19:56 +00:00
2018-10-29 10:45:45 +00:00
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.
2019-02-24 16:02:29 +00:00
**Latest Version:** v0.18 (stable) v0.19-dev (development) ([Changelog](https://github.com/sbrl/Pepperminty-Wiki/blob/master/Changelog.md))
2017-09-14 19:58:54 +00:00
## Screenshot
2018-10-20 16:47:48 +00:00
[![Main Page Example](https://i.imgur.com/5dmbKlz.png)](https://imgur.com/a/lsBc3cM)
2015-09-19 09:19:56 +00:00
## Documentation
2019-01-06 11:45:21 +00:00
For everything you need to know (including how to get your own copy!), you probably want the documentation. It can be found here:
2019-01-03 22:37:30 +00:00
**[Documentation](https://starbeamrainbowlabs.com/labs/peppermint/_docpress/)**
2018-04-07 13:44:55 +00:00
2015-09-19 09:19:56 +00:00
## Real World Usage
2018-12-12 19:27:05 +00:00
None yet! 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:
2015-09-19 09:19:56 +00:00
## Todo
2018-12-12 19:27:05 +00:00
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!).
2015-09-19 09:19:56 +00:00
2018-04-07 13:44:55 +00:00
- Better page history (revert to revision, compare revisions, etc.) (#78, #79)
2018-03-18 22:02:53 +00:00
- Intelligent auto-updating system that doesn't wipe your settings / module choices
- A module registry of some sort (ideas welcome!)
- Image maps (#103)
2019-05-06 13:27:48 +00:00
- 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.
- 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.
2018-03-18 22:02:53 +00:00
- User watchlists
- Theme gallery (#5)
- (See more on the [issue tracker](https://github.com/sbrl/Pepperminty-Wiki/issues)!)
- ...?
2015-09-19 09:19:56 +00:00
2018-12-12 19:27:05 +00:00
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 [send a pull request](https://github.com/sbrl/Pepperminty-Wiki/pulls) - contributions welcome!
2016-03-24 14:00:09 +00:00
2019-01-03 11:16:48 +00:00
## Docker
2019-01-06 11:45:21 +00:00
The recommended way of running Pepperminty Wiki is with a plain PHP-enabled web server. However, a docker container is generaourly provided by @SQL-enwiki. You can run it like so:
2019-01-03 11:16:48 +00:00
2019-01-06 11:45:21 +00:00
```bash
docker run -d sqlatenwiki/peppermintywiki:stable
```
2019-01-03 11:16:48 +00:00
2019-01-06 11:45:21 +00:00
## License
2016-04-23 15:34:51 +00:00
Pepperminty Wiki is released under the Mozilla Public License 2.0. The full license text is included in the `LICENSE` file in this repository.