1. Dave Gauer
  2. Krumpli

Overview

HTTPS SSH

Krumpli Wiki - Alpha!!!!!111!

Do not use this project - just born and under heavy refactoring!

Krumpli is Hungarian for potato, which is an unassuming little tuber.

Overview

Krumpli Wiki (or just Krumpli) stores pages in files and uses no database. Like a proper wiki!

Krumpli allows pages to be in Textile syntax or straight HTML. It uses HummingJay to serve an hm-json REST API. The client-side facilities are created with Mithril.js. It encourages semantic HTML5 and CSS6000.* Like a modern web application!

Pages are given a huge amount of flexibity through a meta document stored alongside the page content. Like a potato!

*Note: there is no CSS6000. I made that up. As of this writing, you're probably best off using CSS2 and maybe some 3. The rest of the information is totally true.

Installation

Use Composer:

composer require <krumpli once I've worked on it hard enough to put it in packagist...>

Composer will install Krumpli in a directory structure like this:

./vendor/ratfactor/Krumpli/

Copy the example directory instead since it will also have css, etc. to make a complete site

Open up your new index.php and following the comments inside to make changes as needed.

Also create a pages directory. Without that, poor Krumpli won't be able to store your pages anywhere! So sad!

|-- /
|   |-- .htaccess (or equivalent)
|   |-- browser.html (optional)
|   |-- index.php
|   |-- template-default.php
|   |-- /vendor/ratfactor/Krumpli
|   |   |-- /example (copy me up to your wiki root level)
|   |-- /pages

Put Krumpli in its own directory and copy the two example documents up a level and remove "example" from their names. Create the other paths as desired.

Open index.php. It is your configuration document as well as the bootstrap for Krumpli (meaning: it includes Krumpli).

Usage

Enjoy!

License

The MIT License (MIT)

Copyright (c) 2015 David Gauer

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.

Version History

I intend to stick to the rules of semantic versioning.

Version Date Description
0.0.1 2015-03-02 Took a chance and it worked, gave it a name, now it's a project