234 lines
14 KiB
HTML
234 lines
14 KiB
HTML
---
|
|
layout: layouts/main
|
|
title: Pepperminty Wiki
|
|
---
|
|
|
|
<div class="double lean-right panel">
|
|
<div class="left centre padding-wide">
|
|
<p>Welcome to Pepperminty Wiki!</p>
|
|
<p>Pepperminty Wiki is a complete wiki engine contained in a single file, inspired by @am2064's <a href="https://github.com/am2064/Minty-Wiki">Minty Wiki</a>. It's <a href="https://github.com/sbrl/Pepperminty-Wiki">open source</a> too (under MPL-2.0), so contributions are welcome!</p>
|
|
<p class="centre-text">
|
|
<a href="https://github.com/sbrl/Pepperminty-Wiki/releases/latest"><img src="https://img.shields.io/github/release/sbrl/Pepperminty-Wiki.svg?color=brightgreen&label=stable" alt="stable version badge" /></a>
|
|
<a href="https://github.com/sbrl/Pepperminty-Wiki/releases"><img src="https://img.shields.io/github/v/release/sbrl/Pepperminty-Wiki?color=yellow&include_prereleases&label=pre-release" alt="pre-release version badge" /></a>
|
|
<img src="https://img.shields.io/badge/dynamic/json?color=orange&label=development&query=latest_version&url=https%3A%2F%2Fstarbeamrainbowlabs.com%2Flabs%2Fpeppermint%2Fpack.php%3Fdetermine-latest-version" alt="development version badge" />
|
|
<!-- ([Changelog](https://github.com/sbrl/Pepperminty-Wiki/blob/master/Changelog.md)) -->
|
|
</p>
|
|
<p class="centre-text">
|
|
<a href="https://raw.githubusercontent.com/sbrl/Pepperminty-Wiki/master/LICENSE"><img src="https://img.shields.io/badge/License-MPL--2.0-blue.svg" alt="License: MPL-2.0" /></a>
|
|
<a href="https://hub.docker.com/r/sqlatenwiki/peppermintywiki"><img src="https://img.shields.io/badge/dynamic/json.svg?color=blue&label=Docker%20Pulls&query=%24.pull_count&url=https%3A%2F%2Fhub.docker.com%2Fv2%2Frepositories%2Fsqlatenwiki%2Fpeppermintywiki%2F" alt="Docker pulls count" /></a>
|
|
</p>
|
|
</div>
|
|
<div class="right perspective">
|
|
<span class="fancy-browser-window feature-tilted">
|
|
<img src="static/images/page-light.png" alt="A screenshot of Pepperminty Wiki" />
|
|
</span>
|
|
</div>
|
|
</div>
|
|
|
|
<section class="panel-small margin-top padding-medium">
|
|
<h2 id="quick-links">Quick Links</h2>
|
|
<div class="display-items">
|
|
<a class="action-button margin-narrow major" href="#features">Features</a>
|
|
<a class="action-button margin-narrow major" href="#screenshots">Screenshots</a>
|
|
<a class="action-button margin-narrow major" href="#download">Download</a>
|
|
</div>
|
|
<div class="display-items">
|
|
<a class="action-button margin-narrow major" href="https://starbeamrainbowlabs.com/labs/peppermint/__nightdocs/01-Welcome.html">Documentation</a>
|
|
<a class="action-button margin-narrow major" href="https://github.com/sbrl/Pepperminty-Wiki">Code Repository</a>
|
|
<a class="action-button margin-narrow major" href="https://starbeamrainbowlabs.com/labs/peppermint/build/">Read-Only Demo</a>
|
|
</div>
|
|
</section>
|
|
|
|
<!-- Feature list -->
|
|
|
|
<h2 class="margin-top" id="features">Features</h2>
|
|
|
|
<div class="feature-list">
|
|
<figure class="feature">
|
|
<img class="invert-when-dark" alt="" src="static/images/icon-file.png" aria-hidden="hidden" />
|
|
<figcaption>
|
|
<strong>No database</strong>
|
|
Simple flat file structure that scales to millions of words and 1000s of pages, and makes for easy backups too!
|
|
</figcaption>
|
|
</figure>
|
|
|
|
<figure class="feature">
|
|
<img class="invert-when-dark" alt="" src="static/images/icon-cloud-download.png" aria-hidden="hidden" />
|
|
<figcaption>
|
|
<strong>Simple installation</strong>
|
|
Just upload a single file to a clean directory on a PHP-enabled web server, and you're good to go!
|
|
</figcaption>
|
|
</figure>
|
|
|
|
<figure class="feature">
|
|
<img class="invert-when-dark" alt="" src="static/images/markdown.svg" aria-hidden="hidden" />
|
|
<figcaption>
|
|
<strong>Markdown syntax</strong>
|
|
Powered by <a href="https://parsedown.org/">Parsedown</a>, familiar <a href="https://www.markdownguide.org/">Markdown</a> syntax with helpful extensions can be used to format your pages. <!-- Power users can make use of the expressive templating syntax too for ultimate composability.-->
|
|
</figcaption>
|
|
</figure>
|
|
|
|
<figure class="feature">
|
|
<img class="invert-when-dark" alt="" src="static/images/icon-magnifying-glass.png" aria-hidden="hidden" />
|
|
<figcaption>
|
|
<strong>Full-text search</strong>
|
|
Find that obscure nugget of information easily with a performant full-text search engine <sup><a href="#footnote-fulltext-search">1</a></sup>!
|
|
</figcaption>
|
|
</figure>
|
|
|
|
<figure class="feature">
|
|
<img class="invert-when-dark" alt="" src="static/images/icon-clock.png" aria-hidden="hidden" />
|
|
<figcaption>
|
|
<strong>Revision history</strong>
|
|
Accidentally delete an important part of a page? No worries. Just check the page revision history. Limited only by the size of your hard drive!
|
|
</figcaption>
|
|
</figure>
|
|
|
|
<figure class="feature">
|
|
<img class="invert-when-dark" alt="" src="static/images/icon-image.png" aria-hidden="hidden" />
|
|
<figcaption>
|
|
<strong>File upload</strong>
|
|
Upload images, videos, audio and more and embed them in your pages!
|
|
</figcaption>
|
|
</figure>
|
|
|
|
<figure class="feature">
|
|
<img class="invert-when-dark" alt="" src="static/images/icon-question-mark.png" aria-hidden="hidden" />
|
|
<figcaption>
|
|
<strong>Inbuilt help page</strong>
|
|
Confused on how to use a feature? The inbuilt dynamic help page is here to help! From Markdown extension syntax to redirect pages, the help page will show you the ropes.
|
|
<!-- Moderators get love too, with extra help sections that appear on login. -->
|
|
</figcaption>
|
|
</figure>
|
|
|
|
<figure class="feature">
|
|
<img class="invert-when-dark" alt="" src="static/images/icon-list-rich.png" aria-hidden="hidden" />
|
|
<figcaption>
|
|
<strong>Page lists</strong>
|
|
Get an overview of the pages on your wiki with a page list. Tags are supported too, for easy logical categorisation of pages.
|
|
</figcaption>
|
|
</figure>
|
|
|
|
<figure class="feature">
|
|
<img class="invert-when-dark" alt="" src="static/images/icon-comment.png" aria-hidden="hidden" />
|
|
<figcaption>
|
|
<strong>Threaded comments</strong>
|
|
Want to discuss a page's content? Per-page threaded comments are just the thing! Email notifications are sent to users verified email addresses <sup><a href="#footnote-threaded-comments">2</a></sup>
|
|
</figcaption>
|
|
</figure>
|
|
</div>
|
|
|
|
<div class="panel-small double lean-left margin-vertical padding-medium">
|
|
<div class="left centre">
|
|
<img class="tall-image-limiter" alt="" src="static/images/android-client-dark.png" />
|
|
</div>
|
|
<div class="right centre">
|
|
<p><strong>Android App</strong></p>
|
|
<p>A native android client app enables browsing your wiki at speed on your phone!</p>
|
|
<p>It's a work in progress, so more features will be added incrementally.</p>
|
|
<div class="display-items margin-top">
|
|
<a class="margin-narrow" href="https://play.google.com/store/apps/details?id=com.sbrl.peppermint">
|
|
<img src="static/images/gplay.svg" alt="Get the app on Google Play" />
|
|
</a>
|
|
<a class="margin-narrow" href="https://github.com/sbrl/Pepperminty-Wiki-Client-Android">
|
|
<img class="invert-when-dark" src="static/images/github.svg" alt="App code on GitHub" />
|
|
</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="feature-small panel padding-medium centre-text">
|
|
<p>And more! Check out the full <a href="https://starbeamrainbowlabs.com/labs/peppermint/__nightdocs/02-Features.html">feature list</a> for an extended list of supported features.</p>
|
|
<p>Don't see a feature you need? <a href="https://github.com/sbrl/Pepperminty-Wiki/issues/new">Open an issue</a>!</p>
|
|
</div>
|
|
|
|
|
|
<!-- Screenshots -->
|
|
|
|
<h2 class="margin-top" id="screenshots">Screenshots</h2>
|
|
|
|
<div class="double lean-left">
|
|
<img class="left margin-medium lift-from-page" src="static/images/page-dark.png" alt="Screenshot showing the dark theme and the menu off" />
|
|
<!-- <div class="left">
|
|
</div> -->
|
|
<div class="right centre padding-wide">
|
|
<p>A dark-theme comes built-in. By using the new <a href="https://caniuse.com/#feat=prefers-color-scheme"><code>prefers-color-scheme</code></a> CSS feature, it's enabled automatically based on your browser preference.</p>
|
|
<p>Pepperminty Wiki is accessible for users of assistive technologies too. It should be pretty great already, but any accessibility issues should be reported by <a href="https://github.com/sbrl/Pepperminty-Wiki/issues/new">opening an issue</a>.</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="double lean-right margin-vertical panel">
|
|
<div class="left centre padding-wide">
|
|
<p>Easily manage user access with the user table. Add and remove users, reset passwords, and view email addresses with ease!</p>
|
|
<p>Multiple wiki-wide themes are also supported - this screenshot is taken with the <em>photo</em> theme, which allows for customisation of the background photo.</p>
|
|
</div>
|
|
<img class="right margin-medium lift-from-page" src="static/images/page-photo-usertable.jpeg" alt="Screenshot showing the user management page with the photo theme" />
|
|
</div>
|
|
|
|
<div class="double lean-left margin-vertical ">
|
|
<img class="left margin-medium lift-from-page" src="static/images/page-dark-recent-changes.png" alt="Screenshot showing the recent changes page" />
|
|
<div class="right centre padding-wide">
|
|
<p>Stay up-to-date with the latest changes to your wiki with the recent changes page. Know exactly who changed what and when.</p>
|
|
<p>File uploads are shown too - along with the size of the file that was uploaded.</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="double lean-right panel">
|
|
<div class="left centre padding-wide">
|
|
<p>The full-text search engine helps you to find what you're looking for - be it part of a page, or a tag.</p>
|
|
<p>Ninjas can use the advanced query syntax to find even the most stubborn of pages.</p>
|
|
</div>
|
|
<img class="right margin-medium lift-from-page" src="static/images/page-search.png" alt="Screenshot showing the search page with the default theme in light mode" />
|
|
</div>
|
|
|
|
|
|
<!-- Download -->
|
|
|
|
<div class="feature-small">
|
|
<h2 class="margin-top" id="download">Download</h2>
|
|
|
|
<div class="padding-horizontal centre-text">
|
|
<p>Download Pepperminty Wiki in the way that's best for you. Simply upload the <code>index.php</code> file you download to an empty directory on your PHP-enabled web server, and you're away!</p>
|
|
<p>If you encounter difficulties, try reading the <a href="https://starbeamrainbowlabs.com/labs/peppermint/__nightdocs/01-Welcome.html">documentation</a>. Still having issues? <a href="https://github.com/sbrl/Pepperminty-Wiki/issues/new">Open an issue</a> and we'll try and help you out.</p>
|
|
<p>Wondering what's changed recently? Check out the <a href="https://github.com/sbrl/Pepperminty-Wiki/blob/master/Changelog.md">changelog</a>.</p>
|
|
<p>
|
|
<a href="https://travis-ci.org/sbrl/Pepperminty-Wiki"><img src="https://travis-ci.org/sbrl/Pepperminty-Wiki.svg?branch=master" alt="Travis CI Build status" /></a>
|
|
<a href="https://gitter.im/Pepperminty-Wiki/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"><img src="https://badges.gitter.im/Pepperminty-Wiki/Lobby.svg" alt="Join the chat at https://gitter.im/Pepperminty-Wiki/Lobby" /></a>
|
|
</p>
|
|
</div>
|
|
|
|
<div class="feature-list">
|
|
<div class="feature vertical centre-text panel-small padding-medium">
|
|
<p>Get a prebuilt version with all the latest features.</p>
|
|
<p><a class="action-button major" href="https://github.com/sbrl/Pepperminty-Wiki/releases/latest">Latest Release</a></p>
|
|
</div>
|
|
<div class="feature vertical centre-text panel-small padding-medium">
|
|
<p>Pick and choose features to include.</p>
|
|
<p><a class="action-button" href="https://starbeamrainbowlabs.com/labs/peppermint/download.php">Online Downloader</a></p>
|
|
</div>
|
|
<div class="feature vertical centre-text panel-small padding-medium">
|
|
<p>Advanced users: Get the ultimate control over the build.</p>
|
|
<p><a class="action-button" href="https://starbeamrainbowlabs.com/labs/peppermint/__nightdocs/05-Getting-A-Copy.html#method-25-using-the-downloader-offline">From Source</a></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="panel-small padding-medium margin-medium centre-text">
|
|
<p>Got your copy? Now check out the getting started guide - contains complete setup instructions and system requirements.</p>
|
|
<br />
|
|
<p><a class="action-button major" href="https://starbeamrainbowlabs.com/labs/peppermint/__nightdocs/04-Getting-Started.html">Getting Started Guide</a></p>
|
|
</div>
|
|
|
|
|
|
<footer class="panel padding-wide-ntop">
|
|
<ol class="list-thin">
|
|
<li id="footnote-fulltext-search"><strong>Full-text search:</strong> Tested on an Intel® Core™ i7-7500U with 5 million words from Wikipedia spread across 2011 pages. Average search time for a single-word query that returned ~307 results was ~110ms.</li>
|
|
<li id="footnote-threaded-comments">The PHP <code>mail()</code> function is used to send email notifications. This requires PHP to be configured to send emails correctly.</li>
|
|
</ol>
|
|
<br />
|
|
<p class="centre-text">Created with ♥ by <a href="https://starbeamrainbowlabs.com/"><img class="logo medium" src="static/images/sbrl.png" alt="SBRL logo" aria-hidden="true" /> Starbeamrainbowlabs</a></p>
|
|
<p class="centre-text">Page content shown in screenshots <a href="https://starbeamrainbowlabs.com/blog/article.php?article=posts/375-next-gen-search-2-test-data.html">pulled</a> from <a href="https://dumps.wikimedia.org/">Wikipedia database dumps</a> | Icons from <a href="https://useiconic.com/open">Open Iconic</a></p>
|
|
<p class="centre-text"><a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img class="logo" title="This website is licenced under the Creative Commons Attribution-ShareAlike 4.0 International License" alt="This website is licenced under Creative Commons Attribution-ShareAlike 4.0 International License" src="static/images/cc-by-sa.svg" /></a></p>
|
|
</footer>
|