search

fablab-luenen / dokuwiki-visual-editor

Modern WYSIWYG editor for DokuWiki based on ProseMirror
https://wysiwyg.wiki.cosmocode.de/
1 stars 0 forks source link
dokuwiki prosemirror wiki wysiwyg

readme

Visual Editor for DokuWiki

Visual Editor logo (graphic design is my passion)

Polished-up version of cosmocode/dokuwiki-plugin-prosemirror, part of the dokuwiki-preconfigured project.

The main aim of this fork is to make the editing experience as seamless as possible. This mostly means getting rid of small annoyances. I probably won't do any serious work on the actual core, since that is already quite solid. Thanks to Cosmocode for doing the hard part!

Visual Editor demonstration. Entering edit mode, scrolling down, changing a bit of formatting, saving

Installation

Extension Manager -> Manual install with URL https://github.com/fablab-luenen/dokuwiki-visual-editor/zipball/release (or manually extract it into /lib/plugins/prosemirror).

Tips and tricks

Fixed/Sticky header

In case your theme has a fixed header, you can configure the toolbar to stick below it while scrolling with the following CSS in userstyle.css:

/* Make menubar stick below header */
.editBox .prosemirror_wrapper .menubar {
    top: 5em; /* Height of your header */
}

Development

Refer to the original project for information about the architecture.

Also note that DokuWiki caches scripts. For changes to show up you can edit scripts.js or disable caching.