143 lines
8.0 KiB
HTML
143 lines
8.0 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 open source 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">
|
|
<!-- TODO: Move the commented ones here down to the download section -->
|
|
<!-- <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> -->
|
|
<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 spin-in">
|
|
<img src="static/images/page-light.png" alt="A screenshot of Pepperminty Wiki" />
|
|
</span>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<!-- Screenshot here opposite above text - insert badge(s) below above text -->
|
|
|
|
<div class="feature-list">
|
|
<figure class="feature">
|
|
<img alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=256&height=256" />
|
|
<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 alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=256&height=256" />
|
|
<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 alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=256&height=256" />
|
|
<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 alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=256&height=256" />
|
|
<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>! Ninjas can use the advanced query syntax to find even the most stubborn of pages.
|
|
</figcaption>
|
|
</figure>
|
|
|
|
<figure class="feature">
|
|
<img alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=256&height=256" />
|
|
<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 alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=256&height=256" />
|
|
<figcaption>
|
|
<strong>File upload</strong>
|
|
Upload images, videos, audio and more and embed them in your pages!
|
|
</figcaption>
|
|
</figure>
|
|
|
|
<figure class="feature">
|
|
<img alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=256&height=256" />
|
|
<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 alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=256&height=256" />
|
|
<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 alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=256&height=256" />
|
|
<figcaption>
|
|
<strong>File upload</strong>
|
|
Upload images, videos, audio and more and embed them in your pages!
|
|
</figcaption>
|
|
</figure>
|
|
</div>
|
|
|
|
<div class="feature-small panel padding-medium centre-text">
|
|
<p>And more! Check out the <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>
|
|
|
|
<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>
|
|
</div>
|
|
</div>
|
|
|
|
<!--
|
|
Things to add:
|
|
- We're open-source
|
|
- Download section: latest release, online downloader, docs for from source
|
|
- Demo
|
|
- Link to docs (at the top and further down?)
|
|
- Link to repo
|
|
- Latest version badges (probably near the top)
|
|
- Screenshots (don't forget to demo the dark mode too)
|
|
- A mention that we (should) be fully accessible - open an issue if there's something that could be improved
|
|
-->
|
|
|
|
<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>
|
|
</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"><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>
|