Skip to main content

Simiki is a simple static site generator for wiki.

Project description

# 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-0.3.1.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

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

simiki-0.3.1-py2.7.egg (28.2 kB view details)

Uploaded Egg

File details

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

File metadata

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

File hashes

Hashes for simiki-0.3.1.tar.gz
Algorithm Hash digest
SHA256 646314d8d50ffb4f09998d5620c1016fdd96c5031b78abe81a4548a7d06076e0
MD5 bb6819a06051417028971a917ac39b14
BLAKE2b-256 bca9d54fa7270b744526748c0714fe69fd53669f2b9dca2b2ccd9b8dbf89e5fd

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for simiki-0.3.1-py2.7.egg
Algorithm Hash digest
SHA256 cd15bdc4c570714f2765f4684e23dbdcb13adce450be63476af9cfe3c3441ff9
MD5 094ff9f518fb28340977360132999740
BLAKE2b-256 6594d74385a9123fe8b8f5b8859cede691ab407ca08bf17ef49d5f604fc0ba44

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