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 是一个用[Python](https://www.python.org/)写的简单的 wiki 框架, 适合分类记录一些技术文档.

  • 简单,适合做个人维基

  • 使用 Markdown 撰写

  • 以分类目录为导向,分类存放源文件

  • 生成静态 HTML 页面

  • 命令行管理工具

## Quick Start ##

### 安装 ###

pip install simiki

### 升级 ###

pip install -U simiki

### 构建站点 ###

mkdir mywiki && cd mywiki simiki init

编辑wiki配置文件`_config.yml` 进行相应配置

### 新建一篇 wiki ###

simiki new -t “Hello Simiki” -c base

### 生成/更新静态页面 ###

simiki generate

### 预览 ###

simiki preview

更多可以查看帮助:

simiki -h

或访问网站 [simiki.org](http://simiki.org/)

## 为什么叫Simiki? ##

Simple Wiki,取了前后各三个字母组成

## 其它 ##

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

Uploaded Source

Built Distribution

simiki-0.3.0-py2.7.egg (28.1 kB view details)

Uploaded Egg

File details

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

File metadata

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

File hashes

Hashes for simiki-0.3.0.tar.gz
Algorithm Hash digest
SHA256 049e07961022b4bfa0c44b32b39aec10b04c3b962660967fe07db85a0b55e7d5
MD5 1c44881348c260bc6132055b7c4ae540
BLAKE2b-256 04da322e4cc5baf3ac26ad4cf2cca6c1629864f00074f46834a74e87700dcb92

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for simiki-0.3.0-py2.7.egg
Algorithm Hash digest
SHA256 7b279f2b1acdef2f42f92582e946cda301cb8de57a27c61ceb0f1cb2796265f9
MD5 d2ffadd88ebed8ece5478eac4ae8313c
BLAKE2b-256 afd298e2d38fca752ac37dca4f60b9ee0de312f5c110e6f1f4036dc029d0c4ef

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