simiki

Simiki is a simple wiki framework, written in Python.

Project description

Simiki is a simple wiki framework, written in Python.

Easy to use. Creating a wiki only needs a few steps
Use Markdown. Just open your editor and write
Store source files by category
Static HTML output
A CLI tool to manage the wiki

Simiki is short for Simple Wiki :)

New in version 1.6.2 (2017-06-02)

Fix issue #88, map url path to local file system path and fix root url with non-ascii

Fix long subcommand not work bug

Fix preview with temporary files generated by editor

Fix fabfile with py3

Update theme simple2

Add Dockerfile

Support Python3.6, remove Python2.6

Support custom markdown extensions configuration, doc <http://simiki.org/docs/configuration.html>_

Enable nl2br(newline to line break) markdown extension by default

New in version 1.6.0.1 (2016-06-30)

Fix issue #64 with python3.x

Installation

It is available for Python 2.7, 3.3, 3.4, 3.5, 3.6, with Linux, Mac OS X and Windows.

Install from PyPI:

pip install simiki

Update:

pip install -U simiki

Quick Start

Init Site

mkdir mywiki && cd mywiki
simiki init

Generate

simiki g

Preview

simiki p

For more information, simiki -h or have a look at Simiki.org

Others

Contribution

Your contributions are always welcome!

Sending pull requests on Pull Requests Page is the preferred method for receiving contributions.

Bug fixes can be based on ``master`` branch and I will also merge into dev branch.
Feature can be based on ``dev`` branch.

Following links are the contribution guidelines you may need:

Thanks to every contributor.

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.