ryanwinchester/kwiki-laravel

Quick wiki or blog with markdown files for laravel

dev-master 2015-09-30 07:08 UTC

This package is auto-updated.

Last update: 2024-02-28 22:26:07 UTC


README

WORK IN PROGRESS, DO NOT USE RIGHT NOW

Version Total Downloads License Scrutinizer Code Quality Build Status

markdown wiki/blog

Usage

Place your markdown files in the /kwiki directory.

Categories are directories and subcategories are subdirectories.

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.

The views are blade templates and located at resources/views/vendor/kwiki and the master layout template is resources/views/vendor/kwiki/master.blade.php

Installation

Using composer:

composer require "ryanwinchester/kwiki: ^0.1"

Publishing config and other assets

There is a good chance you wil want to override some default things. If that is the case there are a couple of way you can go about it. First, you could publish all the things:

php artisan vendor:publish --provider="Kwiki\KwikiServiceProvider" --force

Or you could publish things individually:

Config:

php artisan vendor:publish --provider="Kwiki\KwikiServiceProvider" --tag="config" --force

Views:

php artisan vendor:publish --provider="Kwiki\KwikiServiceProvider" --tag="views" --force

Public assets:

php artisan vendor:publish --provider="Kwiki\KwikiServiceProvider" --tag="public" --force

Translations:

php artisan vendor:publish --provider="Kwiki\KwikiServiceProvider" --tag="translations" --force

Powered by

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