Introduction¶

MyST Editor is a collaborative Markdown editor. It uses MyST - a Markdown flavor intended for technical documentation. For a general introduction to the MyST syntax, please refer to the MyST Markdown Guide. The goal of this manual is to introduce the editor’s features and describe how to use them effectively.

This manual consists of the following chapters:

• Topbar - discusses the elements of the editor topbar

• Collaboration - discusses functionalities related to collaborative edition

• Mermaid Diagrams - discusses support for Mermaid diagrams

• Rich Links - introduces editor-specific syntax for linking to external entities

• Comments - showcases how to use comment functionalities

To try MyST Editor, go to its current demo.