Skip to main content

Simiki is a simple wiki framework, written in Python.

Project description

NOTE : Simiki is currently under heavy development, stable version v1.0 will come soon at June.

# Simiki #

[![Latest Version](http://img.shields.io/pypi/v/simiki.svg)](https://pypi.python.org/pypi/simiki) [![The MIT License](http://img.shields.io/badge/license-MIT-yellow.svg)](https://github.com/tankywoo/simiki/blob/master/LICENSE)

Simiki is a simple wiki framework, written in [Python](https://www.python.org/).

  • Easy to use. Creating a wiki only needs a few steps

  • Use [Markdown](http://daringfireball.net/projects/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 :)

## Quick Start ##

### Install ###

pip install simiki

### Update ###

pip install -U simiki

### Init Site ###

mkdir mywiki && cd mywiki simiki init

### Create a new wiki ###

simiki new -t “Hello Simiki” -c first-catetory

### Generate ###

simiki generate

### Preview ###

simiki preview

For more information, simiki -h or have a look at [Simiki.org](http://simiki.org)

## Others ##

## License ##

The MIT License (MIT)

Copyright (c) 2013 Tanky Woo

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simiki-1.0.0.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simiki-1.0.0-py2.7.egg (34.5 kB view details)

Uploaded Egg

File details

Details for the file simiki-1.0.0.tar.gz.

File metadata

  • Download URL: simiki-1.0.0.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for simiki-1.0.0.tar.gz
Algorithm Hash digest
SHA256 bd67e85b14a612fbb588f299d447e1410699bb5e38a42eb669af982f1fcade63
MD5 a090b2ae09605b09d6f01afb5dadb6e4
BLAKE2b-256 6b7f11b8593da491ee09ee51157bc2c998d10648f57a29da1c34bad124687947

See more details on using hashes here.

File details

Details for the file simiki-1.0.0-py2.7.egg.

File metadata

  • Download URL: simiki-1.0.0-py2.7.egg
  • Upload date:
  • Size: 34.5 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for simiki-1.0.0-py2.7.egg
Algorithm Hash digest
SHA256 26aed62af481ed108c96b3e9d1800a4895af94ea80215d13088944ced3b0eccd
MD5 2577ce7437a410c3bef65ee51e2cbe01
BLAKE2b-256 2299fb197c229a214f8f1a2b6e7d27751bee1864777d0a7bea04941793e6d4ce

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page