savvywombat/wiki-lite

Wiki-Lite: light weight wiki for Laravel 5

1.0.4 2018-06-07 01:23 UTC

README

A light weight wiki for use in Laravel 5

Installation

In your Laravel 5 application, install using Composer.

composer require savvywombat/wiki-lite

You will need to publish the package:

artisan vendor:publish

And select:

SavvyWombat\WikiLite\ServiceProvider

Configuration

A sample configuration is provided in config/wiki-lite.php

By default, the wiki is configured to work as a subdirectory of your site https://example.com/wiki.

An anonymous username has been configured, too (currently, the wiki is not integrated into Laravel's authentication system).

Migrations

Wiki-lite requires two database tables, prefixed with wiki_lite_.

The migrations are installed to your project's database/migrations directory. Simply run artisan migrate to install the databases.

Views

Wiki-lite installs a layout template which wraps the wiki views allowing you to modify and integrate the layout into your project's layout.

The template is installed into views/vendor/savvywombat/wiki-lite/

Usage

When visiting the wiki index page (https://example.com/wiki) for the first time, you will be asked to create a new page with a title.

The wiki uses CommonMark syntax, with one addition - wiki-links.

Linking between wiki pages

You can simply enter any page title (or slug) as a link using:

[[The page title you want to link to]]

When you save the page, you will see a link which takes you to the page you want.

The wiki will also save a link back from the targeted page.

Editing titles

The wiki uses a UUID for each page, meaning that you can edit page titles and any links to the page's previous titles will still link to the latest version of the page.

Comparing revisions

Revision comparison uses unified diff format.

Styling

Some styles are included in the module. They are published into resources/assets/sass/vendor/savvywombat/wiki-lite.

You can import them into your application styles by adding @import "vendor/savvywombat/wiki-lite/wiki-lite" in your app.scss file.

Support

If you are having general issues with this repository, please contact us via the SavvyWombat website.

Please report issues using the GitHub issue tracker. You are also welcome to fork the repository and submit a pull request.

If you're using this repository, we'd love to hear your thoughts. Thanks!

Licence

Wiki-Lite is licensed under The MIT License (MIT).