Markdown Editor

Real-time Preview

The Markdown editor includes a live preview pane that renders your Markdown content as you type. This allows you to see exactly how your document will look without needing to save or switch applications.

Syntax Highlighting

The editor provides comprehensive syntax highlighting for standard Markdown elements, making your content easier to read and understand.

GitLab Flavored Markdown (GFM) Support

The editor fully supports GitLab Flavored Markdown (GFM), including:

• Task Lists: Create interactive task lists with checkboxes.

• Mentions: Easily mention users and groups using @username syntax.

• Emojis: Insert emojis directly into your Markdown.

• Code Blocks: Highlight code blocks with language-specific syntax highlighting.

• Admonitions: Use special blockquotes for notes, warnings, and tips.

Image Upload and Embedding

You can easily upload images directly from your local machine and embed them into your Markdown files. The editor handles the necessary Markdown syntax for image embedding.

Link and Reference Management

The editor assists with creating and managing links, including:

• Internal Links: Link to other Markdown files within your project.

• External Links: Easily add hyperlinks to external websites.

• References: Support for reference-style links.

Table Editing

The editor provides tools to simplify the creation and editing of Markdown tables, including automatic formatting and alignment.

Keyboard Shortcuts

A variety of keyboard shortcuts are available to speed up common Markdown editing tasks, such as applying bold, italics, or creating lists.

Toggling the Preview

You can toggle the visibility of the preview pane using the dedicated button in the editor toolbar or via a keyboard shortcut.

Editor Settings

You can customize various aspects of the Markdown editor's behavior and appearance through the IntelliJ IDEA settings. Navigate to File | Settings | Languages & Frameworks | Markdown to adjust preferences such as:

• Default preview layout

• Font and color schemes

• GFM extensions enablement

MarkdownEditEvents.kt

This file defines a set of events that can be dispatched and listened to within the Markdown editor's lifecycle. These events allow different components to react to user actions or editor state changes. Examples of such events might include:

• DocumentChangedEvent: Fired when the content of the Markdown document is modified.

• PreviewRenderedEvent: Fired when the Markdown preview has been updated.

• ImageUploadedEvent: Fired after an image has been successfully uploaded and embedded.

• LinkInsertedEvent: Fired when a new link is added to the document.

These events are crucial for enabling features like real-time preview updates, automatic saving, and integration with other plugin functionalities.

MarkdownEditor.kt

This file contains the core implementation of the Markdown editor component. It is responsible for:

• Initializing the editor: Setting up the text area, preview pane, and toolbar.

• Handling user input: Processing keyboard and mouse events.

• Applying syntax highlighting: Using an appropriate lexer and highlighter.

• Rendering the preview: Converting Markdown to HTML for display.

• Dispatching events: Notifying other components about editor actions (as defined in MarkdownEditEvents.kt).

• Listening to events: Reacting to events from other parts of the plugin to update the editor state or content.

• Integrating with GitLab APIs: For features like user mentions, issue linking, and image uploads.

By separating concerns into events and a core editor implementation, the plugin maintains a modular and maintainable codebase, allowing for easier future enhancements and integrations.