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.0.1 (2016-06-30)

  • Fix issue #64 with python3.x

New in version 1.6.0 (2016-06-09)

  • Fix issue #60, preview with 127.0.0.1

  • Add page variable, doc

  • Add category settings in _config.yml

  • Add collection and tag, a three-tier structure, doc

  • Add new theme simple2, with collection/tag support

Installation

It is available for Python 2.6, 2.7, 3.3, 3.4, 3.5, 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.0.1.tar.gz (37.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-1.6.0.1-py2.7.egg (88.8 kB view details)

Uploaded Egg

File details

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

File metadata

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

File hashes

Hashes for simiki-1.6.0.1.tar.gz
Algorithm Hash digest
SHA256 2627a3c365940c3b94e65568670ff66f69a4f36a43d65a636f249d5ad161af96
MD5 57024b5fcd2d49993c3e0a45b8668af7
BLAKE2b-256 42839d0095d762295d20d4bca9ab166c56ee445cc70d8a1286f9bab1ea97430c

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for simiki-1.6.0.1-py2.7.egg
Algorithm Hash digest
SHA256 46bb0f60be5bd74b8f681ed13b7335af1274721a01ee9e147574c804f20144d7
MD5 7b30b5e460d35eca8598c372ccec52a6
BLAKE2b-256 e463fcaccf658be4732b75d91b3130af949facf6b577cc64e806392c91331e6b

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