sbrl-github/Pepperminty-Wiki
sbrl-github/Pepperminty-Wiki
1
0
Fork 0
mirror of https://github.com/sbrl/Pepperminty-Wiki.git synced 2024-12-27 15:24:56 +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/
1277 commits 4 branches 62 tags 9.8 MiB
PHP 93%
CSS 5.1%
Shell 1.7%
Dockerfile 0.2%
Find a file
Starbeamrainbowlabs b93dd3d9cc
Start refactoring query_invindex & rename it to invindex_query 
....but of course it's not finished yet. We're doing well, but there are 
a few thorny issues to go.

Mainly: We need to seriously optimise ids::getpagename(), 'cause we'll 
need it a *lot* when we get to implementing the size, before, and after 
colon : directives.
2019-08-18 21:25:48 +01:00
core [apidoc] @since -> @apiVersion 2019-08-08 18:32:24 +01:00
docs Add searhc index format diagram 2019-08-18 20:11:30 +01:00
lantern-build-engine@7365f7d156 Seriously reorganise stuff. Much tidier :D 2018-12-12 23:23:50 +00:00
modules Start refactoring query_invindex & rename it to invindex_query 2019-08-18 21:25:48 +01:00
.gitignore Remove rendered documentation from repository 2019-08-08 18:27:23 +01:00
.gitmodules Seriously reorganise stuff. Much tidier :D 2018-12-12 23:23:50 +00:00
.travis.yml Update PHP versions in Travis CI config 2019-02-01 17:30:08 +00:00
apidoc.json Remove rendered documentation from repository 2019-08-08 18:27:23 +01:00
build.php Add support for core sharding to build script 2019-03-02 21:13:41 +00:00
build.sh build.sh: fix typo 2019-08-08 18:16:56 +01:00
Changelog.md Bugfix: Correct search query performance metrics 2019-08-15 23:46:23 +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 Fix line endings 2018-10-31 16:44:34 +00:00
LICENSE Add license. 2016-03-24 13:58:10 +00:00
logo.png Render svg logo to png 2017-10-28 17:21:12 +01:00
logo.svg Add logo 2017-10-28 17:19:20 +01:00
module_index.json Bugfix: Correct search query performance metrics 2019-08-15 23:46:23 +01:00
nightdocs.toml Use nightdocs instead of docpress. 2019-05-12 12:05:44 +01:00
pack.php build: Cleanup temp file at end of build 2019-03-02 21:59:35 +00:00
package-lock.json Update dependency 2019-08-08 18:07:49 +01:00
package.json Update dependency 2019-08-08 18:07:49 +01:00
peppermint-config-info.php Update title of configuration guide page 2018-08-23 00:24:18 +01:00
peppermint.guiconfig.json Implement initial pdf preview 2019-06-01 20:25:44 +01:00
README.md Bump moar version numbers 2019-07-05 21:28:20 +01:00
theme_blue.css Implement initial pdf preview 2019-06-01 20:25:44 +01:00
theme_default.css Add download button for unsupported file types 2019-06-01 21:37:35 +01:00
version Bump version to v0.20-dev 2019-08-08 18:10:09 +01: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 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!

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.