Skip to content
This repository has been archived by the owner on Jul 20, 2020. It is now read-only.

Latest commit

 

History

History
63 lines (41 loc) · 2.35 KB

readme.md

File metadata and controls

63 lines (41 loc) · 2.35 KB

Miki Documentation

Miki is a small markdown-based wiki system. Beside the basic markdown specs, it also has full support for the markdown extra extension. It is written in PHP using the Silex framework as basis. The pages are saved as .md files in the file structure, no Database is needed.

Installation

  1. Clone the repository.
$ git clone https://github.com/madc/Miki.git
$ cd Miki/
  1. Get Composer and install dependencies.
$ wget https://getcomposer.org/composer.phar
$ php composer.phar install

Visit the Miki startpage in your broser and setup your first page. You probably find it somewhere like https://localhost/path/to/Miki/web/

Inside 'src/config.php' you can change the settings as you like.

Features

Basic Authentication

Miki supports a Basic Authentication. Have a look at src/config.php to set it up. The authentication is based on this Gist by Masao Maeda.

Pages

The first page of your wiki will be the 'Index'. With the default settings, it can be found in 'data/wiki/index.md'. To create a new page, exit the index page and insert a markdown link. After clicking on the link you will get the mask to create a new page.

Hint

Clicking on the page name in header will list all other pages inside the actual category lad allow easy switching.

Example

[Linkname](pagename)

Categories

The pages can also easily be organized in categories. This can be achieved by using a slash inside the page link.

Example

[Linkname w. Category](category/pagename)

Hotkeys

The following keyboard shortcuts are available:

  • Ctrl + E (or Cmd + E on MacOS X) to switch to Edit-Mode
  • Ctrl + S (or Cmd+S) to save changes
  • Alt + Ctrl + X (or Alt + Cmd + X) to dismiss changes
  • Alt + Ctrl + H (or Alt + Cmd + H) to jump to home

Responsive and theme-able via Twitter Bootstrap

The HTML layout is based on Bootstrap 3 and a theme css-file can optionally be defined in the settings.