Pepperminty-Wiki/docs/01-Welcome.md

18 lines
1.6 KiB
Markdown

# Welcome to Pepperminty Wiki!
> A Wiki in a box
[![Build Status](https://travis-ci.org/sbrl/Pepperminty-Wiki.svg?branch=master)](https://travis-ci.org/sbrl/Pepperminty-Wiki)
![GitHub MPL-2.0 license badge](https://img.shields.io/github/license/sbrl/Pepperminty-Wiki.svg)
![GitHub stars badge](https://img.shields.io/github/stars/sbrl/Pepperminty-Wiki.svg)
[![Chat on Gitter](https://img.shields.io/gitter/room/sbrl/Pepperminty-Wiki.svg)](https://gitter.im/Pepperminty-Wiki/Lobby)
[![Docker pulls count](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)](https://hub.docker.com/r/sqlatenwiki/peppermintywiki)
Pepperminty Wiki is a complete wiki engine 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!
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.
_This documentation is brand-new, and still a work-in-progress. If you spot any issues, please let me know by [opening an issue](https://github.com/sbrl/Pepperminty-Wiki/issues/new) :-)_
![Main Page Example](https://i.imgur.com/5dmbKlz.png)