sbrl/pepperminty-wiki-website
sbrl/pepperminty-wiki-website
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Fill out features list

Browse source
This commit is contained in:
Starbeamrainbowlabs 2020-05-08 23:43:22 +01:00
parent 1b0fa08323
commit 2b0d258bc5
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
1 changed files with 99 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

100
src/index.html
View file

@ -3,4 +3,102 @@ layout: layouts/main
title: Pepperminty Wiki
---
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>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>
<div class="feature-list">
<figure>
<img alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=64&amp;height=64" />
<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>
<img alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=64&amp;height=64" />
<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>
<img alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=64&amp;height=64" />
<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>
<img alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=64&amp;height=64" />
<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>
<img alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=64&amp;height=64" />
<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>
<img alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=64&amp;height=64" />
<figcaption>
<strong>File upload</strong>
Upload images, videos, audio and more and embed them in your pages!
</figcaption>
</figure>
<figure>
<img alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=64&amp;height=64" />
<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>
<img alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=64&amp;height=64" />
<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>
<img alt="placeholder" src="https://starbeamrainbowlabs.com/images/placeholder/?width=64&amp;height=64" />
<figcaption>
<strong>File upload</strong>
Upload images, videos, audio and more and embed them in your pages!
</figcaption>
</figure>
</div>
<div class="smallfeature">
<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>
<!--
Things to add:
- We're open-source
- Download section: latest release, online downloader, docs for from source
- Link to docs (at the top and further down?)
- Link to repo
- Latest version badges (probably near the top)
- Screenshots
- A mention that we (should) be fully accessible - open an issue if there's something that could be improved
-->
<footer>
<ol>
<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>
<p></p>
</footer>