Markdown Preview for Sublime Text

Markdown Preview is a Sublime Text plugin that allows you to preview and build markdown files in a web browser. It supports multiple conversion engines:

• Python Markdown (Offline): Uses the python-markdown parser with Pygments for syntax highlighting. It includes pymdown-extensions by default.
• GitHub Markdown API (Online): Converts markdown using GitHub's official API.
• GitLab Markdown API (Online): Converts markdown using GitLab's API.
• External Parsers: Supports the use of other external Markdown parsers.

Key capabilities include MathJax support for mathematical notation, YAML support, image embedding as base64, and the ability to build markdown files using the Sublime Text build system.

To display mathematical notation (inline like \(rac{\pi}{2}\) or block like $$...$$), you must enable MathJax or Katex by correctly configuring the following fields in your settings:

• js
• css
• markdown_extensions

The Markdown previewer supports GitHub-style emoji shortcodes. Emojis are rendered as images linked to GitHub assets. You can use colon-wrapped shortcodes like :smile: or :octocat: to insert emojis into your document.

Supported categories include:

• People: e.g., :smile:, :heart_eyes:, :thumbsup:
• Nature: e.g., :dog:, :moon:, :sunflower:
• Objects: e.g., :apple:, :camera:, :guitar:
• Places: e.g., :airplane:, :restaurant:, :train:
• Symbols: e.g., :arrow_right:, :check_mark:, :copyright:

This is a test for emoji :smile:.  The emojis are images linked to github assets :octocat:.

Markdown Preview provides different ways to render your markdown depending on whether you need offline capability or specific API styling:

1. Offline Mode: Uses the local python-markdown parser. This is ideal for working without an internet connection.
2. GitHub Mode: Uses the GitHub Markdown API to render markdown, ensuring it looks like GitHub's implementation.
3. GitLab Mode: Uses the GitLab Markdown API for GitLab-compatible rendering.
4. Custom Parsers: You can configure the plugin to use other external Markdown parsers.

To get live updates in your browser while editing a file, follow these steps:

1. Enable auto-reload in MarkdownPreview.sublime-settings:

   "enable_autoreload": true,

   Note: This will not work with GitHub or GitLab parsers unless an oauth key is specified.
2. Install the LiveReload package via Package Control.
3. Restart Sublime Text.
4. Open the Command Palette and select LiveReload: Enable/disable plug-ins.
5. Select Simple Reload with delay (400ms). (Using Simple Reload without a delay may cause the preview to be one revision behind).

Once configured, files will auto-reload in the browser whenever you save the document.

Mermaid provides an alternative for rendering UML. Like the standard UML support, this requires the SuperFences extension to create custom fences. You must include the Mermaid library, a configuration file (or your own), and the Mermaid loader in your JavaScript configuration.

"js": [
    // Mermaid library
    "https://unpkg.com/mermaid@8.8.4/dist/mermaid.min.js",
    // User configuration, should be loaded before the loader
    "res://MarkdownPreview/js/mermaid_config.js",
    // Mermaid loader
    "res://MarkdownPreview/js/mermaid.js"
]

The recommended way to install MarkdownPreview is through Package Control in Sublime Text.

1. Ensure Package Control is installed in your Sublime Text environment.
2. Open the Command Palette using the shortcut Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (macOS).
3. Type and select Package Control: Install Package.
4. Search for MarkdownPreview in the list and select it to complete the installation.

1. Ctrl+Shift+P (or Cmd+Shift+P)
2. Package Control: Install Package
3. MarkdownPreview

The parser supports nested code blocks, including those inside lists or blockquotes. This allows you to document code examples within structured Markdown content without breaking the parser.

- This is a list that contains multiple code blocks.

    - Here is an indented block

            ```
            This will still be parsed
            as a normal indented code block.
            ```

    - Here is a fenced code block:

        ```
        This will still be parsed
        as a fenced code block.
        ```

        > ```
        > Blockquotes? 
        > Not a problem!
        > ```