📝 EnlighterJS3 Documentation including all plugins

docs documentation enlighterjs enlighterjs-documentation enlighterjs3-documentation markdown tinymce-plugin tweaks wordpress-plugin

HTML 100%

Find a file

Andi Dittrich 05b1e61dd5 typo		2023-02-11 11:54:55 +01:00
assets	added inline gutenberg tutorial	2020-08-25 15:45:49 +02:00
development	added textOverflow values	2021-11-02 19:17:13 +01:00
editing	added wp shortcode docs	2020-10-13 15:48:09 +02:00
wordpress	typo	2023-02-11 11:54:55 +01:00
.gitignore	updated docs; license CC-NC-SA 4.0	2018-07-21 10:01:40 +02:00
CustomThemes.md	refactored structure; merged Enlighter docs	2020-01-10 13:08:42 +01:00
FAQ.md	added Enlighter.enlight doc	2018-07-27 11:43:56 +02:00
Integration.md	added integration doc	2018-07-27 09:11:38 +02:00
LICENSE.txt	updated docs; license CC-NC-SA 4.0	2018-07-21 10:01:40 +02:00
Mode_of_Operation.md	added mode of operation	2018-07-27 20:22:38 +02:00
README.md	refactored structure; merged Enlighter docs	2020-01-10 13:08:42 +01:00
Tweaks.md	update button label replacement guide	2020-10-29 12:55:35 +01:00

README.md

EnlighterJS3 Documentation

EnlighterJS, an open source syntax highlighter written in pure javascript

EnlighterJS on your Website

Mode of Operation - how EnlighterJS works
Integration - add EnlighterJS to your website
FAQ - Frequently Asked Questions

EnlighterJS editing plugins

TinyMCE - Howto add code snippets via TinyMCE WYSIWYG editor
Gutenberg - Howto add code snippets via WordPress Gutenberg editor

EnlighterJS CMS Integration

Enlighter WordPress Plugin - use EnlighterJS with WordPress - includes full visual editor integration

For Developers

Developer Guide - add new themes and languages
Configuration and Options - configure EnlighterJS
Methods/API - advanced use cases
Tweaks + Advanced Settings - change EnlighterJS visual appearance (low level)

Contribution

EnlighterJS is OpenSource and managed on GitHub - if you like, you're welcome to contribute! To simplify the release and quality control process, please follow these remarks:

One Enhancement ==> One Commit (don't merge a bunch of changes in a single commit!)
Discuss larger project changes with the Maintainer before implementing
Use GitHub for question, bugreports and discussions

License

EnlighterJS Documentation (c) by Andi Dittrich

EnlighterJS Documentation is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

You should have received a copy of the license along with this work. If not, see http://creativecommons.org/licenses/by-nc-sa/4.0/.