sbrl-github/Pepperminty-Wiki
sbrl-github/Pepperminty-Wiki
1
0
Fork 0
mirror of https://github.com/sbrl/Pepperminty-Wiki.git synced 2024-11-22 16:33:00 +00:00
Code Activity

Update README - it was getting rather out of date :P

Browse source
This commit is contained in:
Starbeamrainbowlabs 2016-12-10 12:09:16 +00:00
parent d7a3f88aa9
commit 69ee192c09
1 changed files with 12 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -3,12 +3,14 @@ A Wiki in a box
Pepperminty Wiki is a complete wiki contained in a single file, inspired by @am2064's [Minty Wiki](https://github.com/am2064/Minty-Wiki). It's open source too (under MPL-2.0), so contributions are welcome! Pepperminty Wiki is a complete wiki contained in a single file, inspired by @am2064's [Minty Wiki](https://github.com/am2064/Minty-Wiki). It's open source too (under MPL-2.0), so contributions are welcome!
**Latest Version:** v0.12 (stable) v0.12.1-dev (development) 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 threaded page commenting, autoupdate, and user settings), so check the release notes to see what's been added recently.
**Latest Version:** v0.12.1 (stable) v0.13-dev (development)
## Screenshots ## Screenshots
![Main Page Example](https://i.imgur.com/8TokPXw.png) ![Main Page Example](https://i.imgur.com/8TokPXw.png)
Above: A Main Page. Above: The Main Page used for testing purposes.
## Features ## Features
- Configurable settings - Configurable settings
@ -22,18 +24,23 @@ Above: A Main Page.
- Short syntax for referencing uploaded files - Short syntax for referencing uploaded files
- Client side mathematical expression parsing, courtesy of [MathJax](https://www.mathjax.org/) - Client side mathematical expression parsing, courtesy of [MathJax](https://www.mathjax.org/)
- Links to non-existent pages appear red - Links to non-existent pages appear red
- Full page revision history (comparison / manipulation coming soon)
- Optional time-delayed google search indexing
- Simple edit conflict detection
- Internal links - Internal links
- Links to non-existent pages show up in red - Links to non-existent pages show up in red
- Printable page view - Printable page view
- Customisable theme - Customisable theme
- ~~Basic 'search' bar~~ A full text search engine! - ~~Basic 'search' bar~~ A full text search engine!
- _Dynamic server-side suggestions (coming in v0.13!)_
- (Optional) Sidebar with a tree of all the current pages - (Optional) Sidebar with a tree of all the current pages
- Tags - Tags
- List of all pages and details - List of all pages and details
- List of all tags and pages with any given tag - List of all tags and pages with any given tag
- List of recent changes - List of recent changes
- Inbuilt help page - Inbuilt help page (modules can add their own sections to it)
- File upload - File upload and preview
- Simple syntax for including media in a page (explanation on help page)
- Page protection - Page protection
- Customisable module based system - Customisable module based system
- Allows you to add or remove features at will - Allows you to add or remove features at will
@ -154,12 +161,12 @@ None yet! Contact me or [open an issue](//github.com/sbrl/Pepperminty-Wiki/issue
## Todo ## Todo
Here's a list of things that I want to add at some point (please feel free to [send a pull request](//github.com/sbrl/Pepperminty-Wiki/pulls) and help out!). Here's a list of things that I want to add at some point (please feel free to [send a pull request](//github.com/sbrl/Pepperminty-Wiki/pulls) and help out!).
- ~~Page history~~ (coming in 0.12!)
- Better page history - Better page history
- Password changing - Password changing
- Intelligent auto-updating system that doesn't wipe your settings / module choices - Intelligent auto-updating system that doesn't wipe your settings / module choices
- Preview changes before you save them (#59) - Preview changes before you save them (#59)
- Commenting on pages - Commenting on pages
- (See more on the [issue tracker](https://github.com/sbrl/Pepperminty-Wiki/issues)!)
- ...? - ...?
Is the feature you want to see not on this list? [Open an issue](//github.com/sbrl/Pepperminty-Wiki/issues/new) or [send a pull request](//github.com/sbrl/Pepperminty-Wiki/pulls)! Is the feature you want to see not on this list? [Open an issue](//github.com/sbrl/Pepperminty-Wiki/issues/new) or [send a pull request](//github.com/sbrl/Pepperminty-Wiki/pulls)!