https://github.com/weknowinc/grav-plugin-tui-editor
Tui-Editor Grav Plugin
https://github.com/weknowinc/grav-plugin-tui-editor
Last synced: about 1 year ago
JSON representation
Tui-Editor Grav Plugin
- Host: GitHub
- URL: https://github.com/weknowinc/grav-plugin-tui-editor
- Owner: weknowinc
- License: mit
- Created: 2018-06-24T08:40:00.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-24T19:41:03.000Z (about 8 years ago)
- Last Synced: 2025-06-09T06:03:32.066Z (about 1 year ago)
- Language: JavaScript
- Size: 1.27 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Tui-Editor Plugin
**This README.md file should be modified to describe the features, installation, configuration, and general usage of this plugin.**
The **tui-editor** Plugin is for [Grav CMS](http://github.com/getgrav/grav).
## Installation
Installing the tui-editor plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.
### GPM Installation (Preferred)
The simplest way to install this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm) through your system's terminal (also called the command line). From the root of your Grav install type:
bin/gpm install tui-editor
This will install the tui-editor plugin into your `/user/plugins` directory within Grav. Its files can be found under `/your/site/grav/user/plugins/tui-editor`.
### Manual Installation
To install this plugin, just download the zip version of this repository and unzip it under `/your/site/grav/user/plugins`. Then, rename the folder to `tui-editor`. You can find these files on [GitHub](https://github.com/jmolivas/grav-plugin-tui-editor) or via [GetGrav.org](http://getgrav.org/downloads/plugins#extras).
You should now have all the plugin files under
/your/site/grav/user/plugins/tui-editor
> NOTE: This plugin is a modular component for Grav which requires [Grav](http://github.com/getgrav/grav) and the [Error](https://github.com/getgrav/grav-plugin-error) and [Problems](https://github.com/getgrav/grav-plugin-problems) to operate.
### Admin Plugin
If you use the admin plugin, you can install directly through the admin plugin by browsing the `Plugins` tab and clicking on the `Add` button.
## Configuration
Before configuring this plugin, you should copy the `user/plugins/tui-editor/tui-editor.yaml` to `user/config/plugins/tui-editor.yaml` and only edit that copy.
Here is the default configuration and an explanation of available options:
```yaml
enabled: true
```
Note that if you use the admin plugin, a file with your configuration, and named tui-editor.yaml will be saved in the `user/config/plugins/` folder once the configuration is saved in the admin.
## Usage
**Describe how to use the plugin.**
## Credits
This project use [TUI-Editor](http://ui.toast.com/tui-editor//) GFM Markdown Wysiwyg Editor - Productive and Extensible.
## To Do
- [ ] Add usage instructions
- [ ] Add configurable options
- [ ] Add configurable label for fields