Getting Started
Table of Contents

Simiki

Latest Version
The MIT License
Build Status
Coverage Status

Simiki is a simple wiki framework, written in Python.

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 n -t 'test' -c linux

Generate

simiki g

Preview

simiki p -w

For more information, simiki -h or have a look at Simiki.org

Others

github page的相关概念

Github 为每一个账户都设置了一个默认的 user pages, 如果你要使用,创建的 repository name 必须符合 .github.io,并且 user pages 只能使用这个项目的主分支master来作为发布源。User pages must be built from the master branch.
因此一个账户有且仅有一个 user pages. organization page 和 user pages 类似。那如何在一个账户创建多个 pages呢? 就是另一个 project pages 了。其实每一个项目都可以创建 project pages 来发布。对于project page,你可以选择 master 作为 githubpages 发布源,也可以选择 gh-pages 分支作为发布源,因为pages一般是用来说明项目的,因此项目一般不要使用主分支发布,直接使用 gh-pages 分支更好,这样就和你的 master 代码分开了。如果你就是想要在主分支发布,那么在主分支的root目录下必须要有一个 /docs 目录,发布源代码需要在 /docs 目录下。 自定义域名只要 在发布源的代码目录下面加入CNAME文件即可,里面只需要填写你的自定义域名!如果你的域名还未被DNS收录,那么github会发出警告消息。

我的wiki就是使用 project page,然后 master 是所有的源文件代码目录和markdown笔记文件,但是这个并不是发布源,发布源使用 gh-pages 分支,每次只发布 output 目录下的东西,也就是说我的 gh-pages 分支,只有simiki 生成的output目录下的内容。主分支是整个内容。每次最终要发布的内容推送到 gh-pages 分支,然后备份是推送到 master 分支,这样我的md文件就不会丢失了!在其他电脑上我也可以下载下来编辑和修改,然后重新发布!

配置参考