sbrl-github/Pepperminty-Wiki
sbrl-github/Pepperminty-Wiki
1
0
Fork 0
mirror of https://github.com/sbrl/Pepperminty-Wiki.git synced 2024-12-22 13:45:02 +00:00
Code Activity
A wiki in a box - this is a backup read-only mirror of the main Github repository. https://github.com/sbrl/Pepperminty-Wiki/
1537 commits 4 branches 62 tags 9.8 MiB
PHP 93%
CSS 5.1%
Shell 1.7%
Dockerfile 0.2%
Find a file
Starbeamrainbowlabs d3a918af7a
docs: fiddle with order
2020-04-21 22:32:34 +01:00
core Integrate didyoumean into the main search engine, but it's crashing. 2020-03-15 17:54:27 +00:00
docs docs: fiddle with order 2020-04-21 22:32:34 +01:00
experiments Start Integrating the BkTree into the main Pepperminty Wiki codebase, but there's a long way to go. 2020-03-14 17:49:26 +00:00
lantern-build-engine@5cf2cfebf0 Work on automatic theme index & preview generation 2019-08-25 21:38:28 +01:00
modules Disable the didyoumean typo correction engine by default & add it to the changelog 2020-04-21 22:13:08 +01:00
themes theme/default: Fix mini tag margin 2020-03-14 17:21:14 +00:00
.gitignore Ignore more files 2020-03-05 01:21:34 +00:00
.gitmodules Seriously reorganise stuff. Much tidier :D 2018-12-12 23:23:50 +00:00
.travis.yml Update getting a copy docs 2020-01-12 12:01:21 +00:00
apidoc.json Bump version ready for release :D 2019-11-24 12:01:09 +00:00
build.php Integrate didyoumean into the main search engine, but it's crashing. 2020-03-15 17:54:27 +00:00
build.sh build script: fix cloning of lantern build engine on first clone - fixes #177 2019-12-24 17:34:19 +00:00
Changelog.md Update changelog 2020-04-21 22:32:20 +01:00
composer.json Add luminous as a composer dependency, but it's not used yet 2019-04-25 01:05:50 +01:00
download.php Downloader: fix accessibility issues in Firefox accessibility checker 2020-01-16 19:22:16 +00:00
FUNDING.yml Add GitHub FUNDING definition 2019-12-27 23:36:24 +00:00
LICENSE Add license. 2016-03-24 13:58:10 +00:00
logo.png Optimise logo 2019-08-25 21:36:35 +01:00
logo.svg Add logo 2017-10-28 17:19:20 +01:00
nightdocs.toml Use nightdocs instead of docpress. 2019-05-12 12:05:44 +01:00
pack.php Integrate didyoumean into the main search engine, but it's crashing. 2020-03-15 17:54:27 +00:00
package-lock.json build script: fix cloning of lantern build engine on first clone - fixes #177 2019-12-24 17:34:19 +00:00
package.json Bump version ready for release :D 2019-11-24 12:01:09 +00:00
peppermint-config-info.php Update title of configuration guide page 2018-08-23 00:24:18 +01:00
peppermint.guiconfig.json Disable the didyoumean typo correction engine by default & add it to the changelog 2020-04-21 22:13:08 +01:00
README.md Add stay up-to-date links to README 2020-01-23 23:05:57 +00:00
version Improve search index write & lookup performance by implementing new arr_simple system 2019-12-06 23:40:28 +00:00

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)

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

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 😺

Pepperminty Wiki has been mentioned in a few places though:

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 - coming soon in v0.20!) done, as of v0.20-beta1
  • (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.