README

Content Management System for Orchestra Platform, based on Cello CMS and inspired by WardrobeCMS.

Installation

To install through composer, simply put the following in your composer.json file:

{
	"require": {
		"orchestra/story": "~3.0"
	}
}

And then run composer install to fetch the package.

Quick Installation

You could also simplify the above code by using the following command:

composer require "orchestra/story=~3.0"

Setup

To start using Story CMS, activate the extension from Orchestra Platform Administrator Interface.

Quick Guide

By default, Story CMS is using Markdown format for post and page, however you can customize this by adding your own prefered formatting parser.

Adding new Format

use Orchestra\Story\Facades\StoryFormat;

StoryFormat::extend('bbcode', function () {
    return new BBCodeParser();
});

class BBCodeParser extends Orchestra\Story\Parsers\Parser {}

You can add a new JavaScript text editor using:

Event::listen('orchestra.story.editor: bbcode', function () {
    // Add asset
});

License

The MIT License

Copyright (C) 2012 by Mior Muhammad Zaki <http://git.io/crynobone>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Credit to WardrobeCMS for the inspiration.

orchestra / story

Maintainers

Details