ProductPromotion
Logo

Open.Source

made by https://0x3d.site

GitHub - sbrl/Pepperminty-Wiki: A wiki in a box
A wiki in a box. Contribute to sbrl/Pepperminty-Wiki development by creating an account on GitHub.
Visit Site

GitHub - sbrl/Pepperminty-Wiki: A wiki in a box

GitHub - sbrl/Pepperminty-Wiki: 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 :smiley_cat:

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 open a pull request - 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 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.

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 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 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.

Articles
to learn more about the open-source concepts.

Resources
which are currently available to browse on.

mail [email protected] to add your project or resources here 🔥.

FAQ's
to know more about the topic.

mail [email protected] to add your project or resources here 🔥.

Queries
or most google FAQ's about Open-Source.

mail [email protected] to add more queries here 🔍.

More Sites
to check out once you're finished browsing here.

0x3d
https://www.0x3d.site/
0x3d is designed for aggregating information.
NodeJS
https://nodejs.0x3d.site/
NodeJS Online Directory
Cross Platform
https://cross-platform.0x3d.site/
Cross Platform Online Directory
Open Source
https://open-source.0x3d.site/
Open Source Online Directory
Analytics
https://analytics.0x3d.site/
Analytics Online Directory
JavaScript
https://javascript.0x3d.site/
JavaScript Online Directory
GoLang
https://golang.0x3d.site/
GoLang Online Directory
Python
https://python.0x3d.site/
Python Online Directory
Swift
https://swift.0x3d.site/
Swift Online Directory
Rust
https://rust.0x3d.site/
Rust Online Directory
Scala
https://scala.0x3d.site/
Scala Online Directory
Ruby
https://ruby.0x3d.site/
Ruby Online Directory
Clojure
https://clojure.0x3d.site/
Clojure Online Directory
Elixir
https://elixir.0x3d.site/
Elixir Online Directory
Elm
https://elm.0x3d.site/
Elm Online Directory
Lua
https://lua.0x3d.site/
Lua Online Directory
C Programming
https://c-programming.0x3d.site/
C Programming Online Directory
C++ Programming
https://cpp-programming.0x3d.site/
C++ Programming Online Directory
R Programming
https://r-programming.0x3d.site/
R Programming Online Directory
Perl
https://perl.0x3d.site/
Perl Online Directory
Java
https://java.0x3d.site/
Java Online Directory
Kotlin
https://kotlin.0x3d.site/
Kotlin Online Directory
PHP
https://php.0x3d.site/
PHP Online Directory
React JS
https://react.0x3d.site/
React JS Online Directory
Angular
https://angular.0x3d.site/
Angular JS Online Directory