Editor on Emet CMS

Visual mode

Mon, 01 Jan 0001 00:00:00 +0000

The visual editor is a WYSIWYG editor built on Tiptap, which is a wrapper around ProseMirror. You write, you click buttons, you see formatted text. Under the hood, Emet converts what you see to Markdown on save and back again on load, so the file in your repository is plain Markdown that you could equally well edit in Vim.

That round trip is the interesting part. Most WYSIWYG editors that claim to produce Markdown either produce HTML with a Markdown veneer, or lose things. Emet’s converter knows about GFM tables, task lists, footnotes, definition lists and Hugo shortcodes, and preserves them as the Markdown constructs they are. There are a few things Markdown has no syntax for, covered at the end of this page.

Markdown mode

Mon, 01 Jan 0001 00:00:00 +0000

The Markdown editor shows you the file as it is: frontmatter aside, exactly the text Hugo will read. It’s built on CodeMirror 6, so you get syntax highlighting, search, folding, multiple cursors and, if you want it, Vim. You’ll want it for anything the visual editor can’t express cleanly, raw HTML mostly, and for the days when you’d rather just type.

Switching modes#

The Markdown button at the far right of the visual editor’s toolbar brings you here; the Visual button at the far right of this one takes you back. Emet remembers your choice. The editor.default_mode setting in cms.yaml only decides which mode you see before you’ve made that choice; see Visual mode.

Keyboard shortcuts

Mon, 01 Jan 0001 00:00:00 +0000

Every binding Emet responds to, in one place. Ctrl means Cmd on a Mac unless a table says otherwise. Most of the visual editor’s bindings are Tiptap’s defaults and most of the Markdown editor’s are CodeMirror’s, so if you’ve used either before, your fingers already know a lot of this.

Everywhere#

Shortcut	Action
`Ctrl+S`	Save the open entry (does nothing if there’s nothing to save)
`Ctrl+.`	Toggle focus mode (needs an entry open)
`Esc`	Leave focus mode, unless a dialog is open
`Ctrl+F`	Jump to the entry list filter, when you’re not inside an editor
`Ctrl+K`	Search every section by title or body text, when you’re not inside an editor

Note that Esc leaving focus mode includes the Esc you press to get out of insert mode in Vim, so in focus mode you’ll want jj instead.