These few pages contain documentation and notes for the Mystral Editor (work in progress).
Mystral Editor - Presentation introduces the editor and its features.
Then a series of deeper and more technical notes follows:
additions and modifications record what this editor, begun as a fork of
antmicro/myst-editoradds to it and changes in it.directives
-and -roles lists every directive and role the editor understands, saying for each whether it comes from the markdown-it.docutils library, from the original upstream editor, or from this work. completion describes the suggestions the editor offers while typing -- directives, options, roles, labels, citations and Python.
executable-content covers the Python code cells: writing and running them, what Pyodide can and cannot do, the variable inspector and the keyboard shortcuts.
export covers the PDF, LaTeX, Word and HTML exports and the MyST project commands.
project
-frontmatter -extends explains how a document inherits its settings from the project’s myst.yml,include explains how a document pulls in another file, with the headings, labels and numbers that come with it, and toc documents the in-page table of contents.
customisation documents every key of
config.jsonand thecustom.csshook, and myst-editor -css -variables lists the CSS variables it refers to. keyboard
_shortcuts _en lists the editor’s bindings, including those of the code cells. The two installation guides cover the warnings macOS and Windows show for an unsigned application.
- Mystral Editor
- Mystral Editor - General documentation
- Mystral Editor - General Presentation
- Overview
- Local File Management
- Scientific Authoring
- Python Executable Code Cells (Pyodide)
- Document Organization and Navigation
- Theming and Interface
- Desktop Application (Tauri)
- Customisation
- Getting Started
- Contributing
- Differences vs Myst-Editor (Summary)
- Additions
- Modifications
- Mystral Editor - Precisions and further notes
- Suggestions and completion
- Exporting a document
- Table of contents in the page
- Including another file
- Directives and roles
- Executable content -- code cells
- Project frontmatter and `myst.yml`
- Customisation Reference
- myst-editor — CSS Theming Variables Reference
- 📦 Windows Installation Guide (Microsoft SmartScreen)
- 📦 Installation Guide & macOS Gatekeeper Fix
- Keyboard Shortcuts