Skip to main content

Markdown Editor

A TagSpaces extension allowing viewing and editing of Markdown files.

Features

  • WYSIWYG Markdown editing
  • embedding images, also as data URLs
  • support for emojis 🍒
  • support for tables
  • simple text formatting and headers
  • copy and paste markdown text
  • support math expressions
  • reading aloud the text content of the document
  • visualizing the markdown header structure as mindmap

Screenshot of the markdown editor

The following video will present some of the features:

Markdown editor - feature overview

TIP: Just type / on a new line to get a menu showing all available markdown elements such as headings, bullet lists, images, quotes or tables.

Mindmap

The extension can generate a mindmap structure of the document based on its header structure.

Screenshot of the markdown editor

Diagrams

The editor supports presenting and editing of mermaid based diagrams:

Mermaid based diagrams in the markdown editor

Live Demo

You can test it live here.

Used libraries

This extension thankfully relays on the following libraries:

Keyboard shortcuts

Mod is Cmd on macOS and Ctrl for Windows/Linux.

Essentials

ActionKey
CopyMod-c
CutMod-x
PasteMod-v
New LineEnter
Exit CodeMod-Enter
PrintMod-p
SaveMod-s

History

ActionKey
UndoMod-z
RedoMod-Shift-z

Mark

ActionKey
BoldMod-b
ItalicMod-i
Inline CodeMod-e
Strike ThroughMod-Alt-x

Paragraph

ActionKey
Normal TextMod-Alt-0
H1Mod-Alt-1
H2Mod-Alt-2
H3Mod-Alt-3
H4Mod-Alt-4
H5Mod-Alt-5
H6Mod-Alt-6
Code FenceMod-Alt-c
Line BreakShift-Enter

List

ActionKey
Ordered ListMod-Alt-7
Bullet ListMod-Alt-8
Task ListMod-Alt-9
Sink List ItemMod-]
Lift List ItemMod-[

Table

ActionKey
Next CellMod-]
Prev CellMod-[
Exit Table and BreakMod-Enter

Installation

This extensions is packaged with any new version of TagSpaces

Source code

The source code of this extension is freely available on GitHub

Development

If you want to extend this extensions, please follow our general extension development guide

License

MIT