Skip to main content

Simiki is a simple wiki framework, written in Python.

Project description

Latest Version The MIT License Build Status Coverage Status

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)

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.6.2.tar.gz (39.6 kB view details)

Uploaded Source

Built Distribution

simiki-1.6.2-py2.7.egg (93.4 kB view details)

Uploaded Egg

File details

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

File metadata

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

File hashes

Hashes for simiki-1.6.2.tar.gz
Algorithm Hash digest
SHA256 cfd16ce6ea2995301f5ccd74d00661fa0cbf804318ca8b6de6e83f0f358c3a13
MD5 f27b3be7b733919832e9e5f3d927c3eb
BLAKE2b-256 4b3613927e31d937c66899f703c2a5b0f83cea347408e80f5cb8c103c2e0f32a

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for simiki-1.6.2-py2.7.egg
Algorithm Hash digest
SHA256 410de117a7a05ac2a87de60ae724a6ba4bd431a60aba0a2cf9ea4b693cc9776a
MD5 2b4ccc4cbd42acf84bc0b988bdadcf14
BLAKE2b-256 0d46fcddb61444eb92dad0003c1855fe1337b94ec4a29ea9658d9bf3c90ababe

See more details on using hashes here.

Supported by

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