Git Product home page Git Product logo

kirby-tinymce's Introduction

Kirby TinyMCE

GitHub issues GitHub license

Kirby TinyMCE is the classic and familliar WYSIWYG editor TinyMCE as a panel field for Kirby 3 CMS.

The plugin is currently in its early development stages. Expect bugs. Check out the develop branch for updates.

Requirements

  • PHP 7.1+
  • Kirby 3.0.0+

Included Dependencies

  • Markdownify 2.3
  • TinyMCE Vue component 2.1.0

Installation

Download ZIP

Download or clone the repository and extract it to site/plugins/tinymce within your project root.

Composer

Git Submodule

If you're using Git to manage your project, you can add this plugin as a Git submodule.

$ cd your/project/root
$ git submodule add https://github.com/PaulMorel/kirby-tinymce.git site/plugins/tinymce

Usage

Blueprints

Once the plugin is installed, you can start using TinyMCE in your blueprints:

text:
  label: Text
  type: tinymce
  plugins:
    - work in progress
  menubar: format help
  toolbar: bold italic anchor

If you wish, you can also set global defaults in your config.php file:

c::set('plugin.tinymce.plugins', '');
c::set('plugin.tinymce.toolbar, '');
c::set('plugin.tinymce.menubar, '');

These options will be overridden by any options set on individual fields.

If neither are set, the field will use sensible defaults.

Options

plugins

Allows you to specify which plugins TinyMCE will attempt to load when starting up. See the TinyMCE documentation for more detailed information.

Type: String

Currently available plugins:

  • autolink
  • autoresize
  • charmap
  • code
  • codesample
  • colorpicker
  • contextmenu
  • directionality
  • hr
  • image
  • insertdatetime
  • link
  • lists
  • media
  • nonbreaking
  • paste
  • searchreplace
  • tabfocus
  • table
  • template
  • visualblocks
  • visualchars
  • wordcount

toolbar

Allows you to specify the controls that should appear on TinyMCE's toolbar. See the TinyMCE documentation for more detailed information.

Type: String|Array|Bool

menubar

Allows you to specify which menus should appear on TinyMCE's menubar. See the TinyMCE documentation for more detailed information.

Type: String|Bool

Changelog

0.1.0

  • Initial Preview Release

Roadmap

  • Internationalisation and localisation where applicable
  • Add unit tests where applicable
  • Add individual plugin options
  • Update theme to match panel styles

Contributing

Any suggestion or contribution is welcome. Don't hesitate to create Issues and Pull Requests.

License

This repository is under the GNU LGPL v2.1 license.

Acknowledgments

Kirby CMS by Bastian Allgeier
TinyMCE by Ephox
Parsedown & Parsedown Extra by Emanuil Rusev
Markdownify by Milian Wolff & Thomas Zilliox

kirby-tinymce's People

Contributors

paulmorel avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.