README

Simple wiki for the CMS.

This module adds a wiki that may be browsed and maintained by CMS users.

Its recommended use is to provide in-application documentation about the CMS. For example: editors can browse the wiki to read about custom CMS functionality; administrators can maintain the wiki contents.

To be used to with the Laravel CMS Core.

This package is compatible and tested with Laravel 5.3 and 5.4.

Installation

Add the module class to your cms-modules.php configuration file:

    'modules' => [
        // ...
        Czim\CmsWikiModule\Modules\WikiModule::class,
    ],

Add the service provider to your cms-modules.php configuration file:

    'providers' => [
        // ...
        Czim\CmsWikiModule\Providers\CmsWikiModuleServiceProvider::class,
        // ...
    ],

To publish the config and migration:

php artisan vendor:publish

Run the CMS migration:

php artisan cms:migrate

Usage

The wiki will automatically be present in your menu, with a link to the home page.

Security

As with any module, only authenticated CMS users can access its routes.

Additionally a non-admin user must have the following permissions:

Permission key	Description
wiki.page.create	Create new wiki pages
wiki.page.edit	Edit existing wiki pages
wiki.page.delete	Delete wiki pages

Or simply set wiki.page.* for all of the above.

Contributing

Please see CONTRIBUTING for details.

Credits

All Contributors

License

The MIT License (MIT). Please see License File for more information.

czim / laravel-cms-wiki-module

Maintainers

Details