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)

Related

• Website
• Examples
• EnlighterJS Repository

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:

1. One Enhancement ==> One Commit (don't merge a bunch of changes in a single commit!)
2. Discuss larger project changes with the Maintainer before implementing
3. 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/.