Start filling out some of the new documentation pages

This commit is contained in:
Starbeamrainbowlabs 2018-12-12 21:43:46 +00:00
parent d1b7fc2a7e
commit 510f84a91b
Signed by: sbrl
GPG Key ID: 1BE5172E637709C2
4 changed files with 73 additions and 2 deletions

View File

@ -6,6 +6,4 @@ Pepperminty Wiki is a complete wiki contained in a single file, inspired by @am2
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.
Explore the sections on the left-hand-side to learn more.
![Main Page Example](https://i.imgur.com/5dmbKlz.png)

View File

@ -0,0 +1,46 @@
# Features
Peppeminty Wiki has actually acquired a rather extensive feature set.
- Configurable settings
- Via `peppermint.json`
- GUI available for moderators
- User login system
- Graphical user management table for moderators
- Page creation
- Subpages fully supported
- Markdown-powered syntax
- Powered by [Parsedown Extra](https://github.com/erusev/parsedown-extra/), with additional extras
- Short syntax for:
- Referencing uploaded files
- Internal Links - links to non-existent pages show up in red
- Templating support
- Additional syntax for resizing and floating images (see inbuilt help page)
- File galleries
- Client-side mathematical expression parsing, courtesy of [MathJax](https://www.mathjax.org/) [optional]
- Full page revision history (comparison / manipulation coming soon)
- Optional time-delayed search indexing
- Simple edit conflict detection
- Edit previewing (since v0.14, thanks to @ikisler)
- Printable page view
- Customisable theme
- ~~Basic 'search' bar~~ A full-text search engine!
- Dynamic server-side suggestions (since v0.13!)
- Sidebar with a tree of all the current pages [optional]
- Page tags
- Page lists
- List of all pages
- List of all tags
- List of pages with a given tag
- List of recent changes
- Inbuilt help page
- Dynamic - modules can add their own sections to it
- File upload and preview
- Simple syntax for including media in a page (explanation on help page)
- Page protection
- Simple user settings page
- Set email address
- Change password
- Threaded page comments (since v0.14)
- Statistics system - can be extended by modules (since v0.15)
- Customisable module based system
- Allows you to add or remove features at will

View File

@ -0,0 +1,26 @@
# Screenshots
This is just a small sample of what Pepperminty Wiki can do. Go to the [Getting Started](04-Getting-Started.md) to spin up your own instance, or head directly to [the downloader](https://starbeamrainbowlabs.com/labs/peppermint/download.php) to grab a copy now!
#### Example Main Page
Showcases threaded page comments too!
![](https://i.imgur.com/6Td1HSP.png)
#### All Pages List
![](https://i.imgur.com/QigtoJ9.png)
#### Page Editor
![](https://i.imgur.com/g3N2Uex.png)
#### Search Results
![](https://i.imgur.com/a5FjnJh.png)
#### Recent Changes
Changes are split by date. Multiple changes can be shown under a single date heading, it's just not shown here :-)
![](https://i.imgur.com/MXU9npR.png)
#### User Management Table
The user management table, which is only accessible to moderators.
![](https://i.imgur.com/ATi3iV1.png)

View File

@ -3,6 +3,7 @@
* [Pepperminty Wiki](01-Welcome.md)
* [Features](02-Features.md)
* [Screenshots](03-Screenshots.md)
* [Demo](https://starbeamrainbowlabs.com/labs/peppermint/build/)
* [Getting Started](04-Getting-Started.md)
* [Installation](05-Installation.md)
* [Configuration](06-Configuration.md)