Skip to content
JindΕ™ich Stoklasa edited this page Apr 11, 2026 · 22 revisions

πŸ–ŠοΈ Neiki Editor Wiki

Lightweight WYSIWYG Rich Text Editor Zero dependencies Β· 30+ tools Β· Light & Dark themes

Version License


πŸ‘‹ Welcome

Welcome to the official Neiki Editor documentation wiki! Here you'll find everything you need to install, configure, extend, and integrate the editor into your projects.

Tip

New to Neiki Editor? Start with the Getting Started guide β€” you'll have a working editor in under 2 minutes.


πŸ“– Wiki Pages

Page Description
πŸš€ Getting Started Installation, CDN setup, and your first editor
βš™οΈ Configuration All configuration options explained in detail
πŸ”§ Toolbar Reference Complete list of 30+ toolbar buttons
πŸ”Œ Plugin API Build custom plugins and extend the editor
πŸ”— Integration Guide PHP, Vue.js, React, and AJAX examples
🧩 Advanced Features Tables, images, themes, find & replace, and more

⚑ Quick Start

<!-- 1. Include assets -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/neikiri/neiki-editor@2.2.1/dist/neiki-editor.css">
<script src="https://cdn.jsdelivr.net/gh/neikiri/neiki-editor@2.2.1/dist/neiki-editor.js"></script>

<!-- 2. Create a textarea -->
<textarea id="editor"></textarea>

<!-- 3. Initialize -->
<script>
  const editor = new NeikiEditor('#editor');
</script>

Note

That's it β€” zero config required. The editor replaces the <textarea> with a full-featured WYSIWYG editor automatically.


🌟 Key Features

✍️ Rich Text Editing

  • Bold, italic, underline, strikethrough
  • Headings (H1–H6), font size, font family
  • Text & background colors
  • Subscript, superscript

πŸ“Š Advanced Content

  • Table creation with context menu
  • Image upload (URL, file, drag & drop)
  • Emoji & special characters pickers
  • Blockquotes, horizontal rules, lists

🎨 Themes & UI

  • Light & Dark themes with toggle
  • Localization (English, Czech)
  • Floating toolbar on text selection
  • Fullscreen editing mode
  • Status bar (word count, block type)

πŸ”Œ Developer Friendly

  • Zero dependencies
  • Plugin API for custom extensions
  • PHP integration helper included
  • Vue.js & React compatible
  • Save, Preview, Download, Print built-in

⌨️ Keyboard Shortcuts

Shortcut Action
Ctrl+B Bold
Ctrl+I Italic
Ctrl+U Underline
Ctrl+K Insert Link
Ctrl+S Save (triggers onSave callback)
Ctrl+Z Undo
Ctrl+Y / Ctrl+Shift+Z Redo
Tab Indent
Shift+Tab Outdent

🌐 Browser Support

Browser Support
Chrome βœ… Latest
Firefox βœ… Latest
Safari βœ… Latest
Edge βœ… Latest
Opera βœ… Latest

Important

Neiki Editor relies on contentEditable and document.execCommand, which are supported in all modern browsers. Internet Explorer is not supported.


πŸ“ Project Structure

neiki-editor/
β”œβ”€β”€ dist/
β”‚   β”œβ”€β”€ neiki-editor.js       # Editor core
β”‚   └── neiki-editor.css      # Editor styles
β”œβ”€β”€ demo/
β”‚   └── index.html            # Interactive demo page
β”‚   └── logo.png              # Demo logo
β”œβ”€β”€ php/
β”‚   └── neiki-editor.php      # PHP integration helper
β”œβ”€β”€ logo.png
β”œβ”€β”€ package.json
β”œβ”€β”€ README.md
β”œβ”€β”€ LICENSE
β”œβ”€β”€ CHANGELOG.md
β”œβ”€β”€ CONTRIBUTING.md
β”œβ”€β”€ CODE_OF_CONDUCT.md
└── SECURITY.md

πŸ“„ License

Neiki Editor is released under the MIT License. See LICENSE for details.


Made with ❀️ for the web community

Clone this wiki locally