flowedit.
FLOWEDIT DOCUMENTATION

Getting started

From the plugin documentation · View source ↗

FlowEdit 1.0.0-rc.1 is the first release candidate for 1.0. Existing pages require no migration. Read the changelog before upgrading. This release includes the visual block builder and both prebuilt Admin2 bundles; no Node.js build is needed to follow the builder guides.

Requirements

  • Grav >= 2.0.19
  • Admin2 >= 2.1.0
  • API plugin >= 1.0.19
  • Shortcode Core >= 6.2.5

Version and dependency constraints are authoritative in blueprints.yaml.

Installation

Place the chosen release’s files in user/plugins/flow-edit, with flow-edit.php directly inside that folder. When that version is available in your GPM channel, you can also install it through Admin2 (Plugins → Add) or the GPM CLI. Check blueprints.yaml to confirm the installed version. No build step is needed on a Grav install — the editor and block-management bundles (admin-next/fields/flow-edit.js and admin-next/pages/flow-edit.js) ship pre-built with the builder version.

After updating, refresh Admin2 to load both updated bundles and the editor’s content-save protection. See draft recovery and save conflicts for how to keep your changes if someone else edits the page.

Enabling

  1. Keep the plugin enabled (flow-edit.yaml defaults to enabled: true).
  2. In Admin2, open your account settings and set Content Editor to FlowEdit. The choice is per user; other editors on the same site are unaffected.
  3. Ensure pages use process.markdown: true in their front matter so the stored Markdown renders on the front end.

Selecting Default or CodeMirror stops using FlowEdit without disabling the plugin — no content is converted in either direction.

Uninstalling / disabling safely

FlowEdit’s storage format is Markdown plus [flow-*] shortcodes. Keep FlowEdit and Shortcode Core enabled while any page stores a [flow-youtube], [flow-image], [flow-gallery], [flow-video], [flow-embed], [flow-columns], or [flow-block] shortcode. Otherwise, that content stops rendering on the public site. See the shortcode reference.

Next steps