https://github.com/czim/laravel-cms-wiki-module
Simple wiki documentation module for the Laravel CMS
https://github.com/czim/laravel-cms-wiki-module
cms documentation laravel live-preview markdown wiki
Last synced: 5 months ago
JSON representation
Simple wiki documentation module for the Laravel CMS
- Host: GitHub
- URL: https://github.com/czim/laravel-cms-wiki-module
- Owner: czim
- License: mit
- Archived: true
- Created: 2017-06-24T15:57:14.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-25T20:59:41.000Z (almost 9 years ago)
- Last Synced: 2025-05-09T13:03:17.423Z (about 1 year ago)
- Topics: cms, documentation, laravel, live-preview, markdown, wiki
- Language: PHP
- Size: 50.8 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# CMS for Laravel - Wiki Documentation Module
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](https://github.com/czim/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:
``` php
'modules' => [
// ...
Czim\CmsWikiModule\Modules\WikiModule::class,
],
```
Add the service provider to your `cms-modules.php` configuration file:
``` php
'providers' => [
// ...
Czim\CmsWikiModule\Providers\CmsWikiModuleServiceProvider::class,
// ...
],
```
To publish the config and migration:
``` bash
php artisan vendor:publish
```
Run the CMS migration:
```bash
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](CONTRIBUTING.md) for details.
## Credits
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/czim/laravel-cms-wiki-module.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/czim/laravel-cms-wiki-module.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/czim/laravel-cms-wiki-module
[link-downloads]: https://packagist.org/packages/czim/laravel-cms-wiki-module
[link-author]: https://github.com/czim
[link-contributors]: ../../contributors