Prosemirror Plugin

Compatible with DokuWiki

2024-02-06 "Kaos" yes
2023-04-04 "Jack Jackrum" yes
2022-07-31 "Igor" unknown
2020-07-29 "Hogfather" unknown

A WYSIWYG editor for DokuWiki, usable but currently only in beta state

Last updated on: 2024-10-08
Provides: Action
Repository: Source
Conflicts with: ckgedit, codemirror, note

Tagged with !experimental, editing, editor, wysiwyg

By Andreas Gohr, Michael Große

This plugin implements a WYSIWYG editor. Unlike other WYSIWYG plugins, it does not repurpose a HTML editor but uses an editor component written specifically for DokuWiki utilizing the ProseMirror framework. You can learn more about the approach at Why a new WYSIWYG plugin?.

Beta State!

Prosemirror is usable but in a Beta State

It is still in the development and test phase and might have bugs, incomplete features, or other issues that are being worked on. Users can try it out, give feedback, and help identify problems, but it might not be as stable or polished as the final version. However, if it is used productively, you should (perhaps temporarily) switch to the DokuWiki default editor if something does not work as you expect it to.

Installation

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

Try it out

You can try out this plugin at wysiwyg.wiki.cosmocode.de.

Development

How to help with Development

Travis:
Scrutinizer:

Adding Plugin Support

Adding support for your syntax plugin is possible, but it is a complex endeavor. Please work through the Prosemirror Library Guide before attempting an integration. After you have done this, please continue to the plugin support subpage.

Commit-Ticker

Bump version (2024-10-08 18:25)
Remove obsolete code (2024-10-08 12:26)
Code style fixes (2024-10-08 12:24)
Update media paths in test data (2024-10-08 11:51)
Remove superfluous semicolon (2024-10-08 10:57)
🤖 Automatic code style fixes (2024-10-08 10:53)
Update GitHub workflows (2024-10-08 10:51)
Explicitly add PM view object to the public API (2024-10-08 10:34)

Releases:

Utilized DokuWiki Events

FAQ

What is the purpose of the “plugin” button (drop down)?: I mostly figured out all buttons on the toolbar of the Visual Editor. However, on the right end there is a “plugin” button with a drop down arrow on its right. clicking on it offers 2 options: “plugin block” and “plugin inline”. I cannot figure out what these do (if anything).

Table of Contents