Markdown Support: Configuration
Configuring Markdown Support: plugin on/off, default format, format switching, auto-conversion and toolbar with default values, effect and the validation rule on save.
Markdown Support: Configuration
Open the configuration in the admin panel under Manage > Plugins > Markdown Support. The labels in the form are defined in English in the plugin. A German language pack for the plugin is included.
Options
| Option | Default | Effect |
|---|---|---|
| Enable Markdown Support | On | Turns the Markdown format on as a whole. When Off, the plugin neither extends the core nor attaches the editor, signals or email handling |
| Default Thread Entry Format | Markdown | Format the editor starts with. Choices: HTML (WYSIWYG) or Markdown |
| Allow Format Switching | On | Shows the Format selector with Markdown and HTML above the input field. When Off, only the default format is available |
| Auto-Convert Markdown Syntax | Off | Stores entries without a format value as Markdown when Markdown syntax is detected. See API integration |
| Show Markdown Toolbar | On | Shows the toolbar with the formatting buttons above the input field |
| Installed Version | empty | Read-only. The plugin maintains the value itself |
There is no option for the live preview. It is always active in Markdown mode, except in the compact input fields (see Usage).
How the options interact
- Default format HTML: The editor starts with the normal osTicket WYSIWYG editor. With format switching on, you can switch an individual entry to Markdown.
- Default format Markdown, format switching off: The editor stays in Markdown mode, switching to HTML is not possible.
- Toolbar off: In Markdown mode only the input field with the preview appears, without buttons. The keyboard shortcuts keep working.
The auto-conversion can only be saved if Enable Markdown Support is also on. Otherwise the form reports
Auto-convert requires Markdown Support to be enabled.
Applying changes
The plugin hands the configuration to the browser when the page loads. After a change, reloading the ticket page is enough. No restart is needed.
Options that do not exist
There is no option for the auto-detection threshold or for the live preview. The threshold is fixed at 5 in the plugin.