fungku/kwiki

Quick wiki or blog with markdown files

Kwiki

, _(*1)

, _(*2)

markdown wiki/blog

Usage

Place your markdown files in the /wiki directory., _(*3)

Categories are directories and subcategories are subdirectories., _(*4)

If you place an index.md in a category or subcategory directory, it will be parsed and displayed after the list of subcategories and files., _(*5)

The views are blade templates and located at resources/views/wiki and the master layout template is resources/views/master.blade.php, _(*6)

Installation

Using composer:, _(*7)

$ composer create-project fungku/kwiki --prefer-dist

Setup

From the project root, rename .env.example to .env, _(*8)

$ mv .env.example .env

Edit .env for your environment. i.e. change from local to production on your production server, and change debug to false., _(*9)

Using a different parser

By default the markdown parser used is erusev/parsedown. To use a different one, you need to make your own parser that implements the Parseable interface or create an adapter for a different library that implements Parseable. Then, you should change the binding in app/Providers/AppServiceProvider.php to your custom parser., _(*10)

$this->app->bind(Parseable::class, MyCustomParser::class);

Understanding the data passed to your views

You will have four variables you can use in your wiki page view:, _(*11)

1. $title is the title of the post or category.
2. $breadcrumbs is an array of breadcrumbs with href and name indexes
3. $index is available if you have navigated to a directory, or an empty array otherwise
   • $index['subcategories'] is an array of subdirectories in your current directory with href and name indexes
   • $index['files'] is an array of files in your current directory with href and name indexes
4. $post is a string of your parsed markdown content

Changing default directories

Move or rename your wiki directory to wherever or whatever you want. Just update app/Http/Controllers/WikiController.php variable $wikiPath., _(*12)

Move or rename your wiki view template to wherever or whatever you want. Just update app/Http/Controllers/WikiController.php variable $wikiView., _(*13)

The default styling is very basic

By default we include a bootswatch theme from a CDN and public/css/app.css for custom styles., _(*14)

Navigating to a category example:, _(*15)

, _(*16)

Plans

Plans for the near future might be a bit nicer default style. Otherwise, I'm completely open to criticisms and suggestions since it already fulfils my requirements., _(*17)

I might extract a package out of it, but it will be laravel-specific, due to the routes, controllers, and service provider., _(*18)

If you wanted something outside of the laravel universe you could roll your own and you might be interested in my pagemark package linked below., _(*19)

Powered by

• Lumen - Laravel's official micro framework
• Pagemark - A package I wrote that basically does all the work
• Parsedown - A popular markdown parser, and this project's default