如何在VSCode的Jupyter Notebook中设置及修改默认渲染MIME类型

Hey there! Let's tackle how to set and modify the default rendered MIME type in Jupyter Notebooks within VS Code. I've got you covered with practical, step-by-step approaches—both global settings and per-notebook overrides, plus how to customize the rendered content itself.

1. Global Default via VS Code Settings #

If you want all your notebooks to use a consistent default MIME type, adjust VS Code's built-in settings:

• Open VS Code, hit Ctrl+, (or Cmd+, on Mac) to launch the Settings panel.
• In the search bar, type Jupyter: Preferred Mime Type to locate the setting.
• From the dropdown menu, pick your desired default. Common options include:
  • text/html (prioritizes HTML output rendering)
  • text/markdown (renders Markdown content by default)
  • application/json (formats JSON outputs neatly)
  • image/png (gives priority to image outputs)
• Save the settings, and VS Code will apply this default to all future Jupyter Notebook sessions.

2. Per-Notebook/Cell Override via Code #

Sometimes you don't want a global change—here's how to adjust defaults for a single notebook or cell:

Override for a Single Cell #

Force a specific cell's output to use your chosen MIME type with IPython's display module:

from IPython.display import display, HTML, Markdown

# Force render as styled HTML
display(HTML("<h2>Custom HTML Output</h2>"), raw=True)

# Force render as Markdown
display(Markdown("### This is Markdown, rendered by choice!"), raw=True)

Set Default for the Entire Notebook #

Modify the notebook's metadata to set a default MIME type for all outputs:

1. Open your notebook, click the gear icon (Settings) in the top-right corner of the notebook interface.
2. Select Edit Notebook Metadata.
3. In the JSON editor that opens, add or update the jupyter -> outputs -> mimetype field. Example:

{
  "kernelspec": {
    "name": "python3",
    "display_name": "Python 3"
  },
  "jupyter": {
    "outputs": {
      "mimetype": "text/html"
    }
  }
}

4. Save the metadata and restart the notebook kernel for changes to take effect.

If you want to customize how a specific MIME type looks (not just which one is default), use IPython's custom display formatters.

Example: Custom HTML Rendering #

Add a consistent style to all HTML outputs by registering a custom renderer:

from IPython.display import HTML, display_formatter

def custom_html_styler(obj):
    # Wrap HTML content with a custom border and padding
    styled_content = f"""
    <div style="padding: 12px; border: 2px solid #4CAF50; border-radius: 6px; background-color: #f8fff9;">
        {obj.data}
    </div>
    """
    return styled_content

# Register the custom formatter for text/html
display_formatter.formatters['text/html'].for_type(HTML, custom_html_styler)

# Test it out—all future HTML outputs will use this style
display(HTML("<p>This HTML gets a green border automatically!</p>"))

Example: Custom JSON Rendering #

Tweak how JSON outputs are formatted (e.g., add indentation or sort keys):

import json
from IPython.display import display_formatter

def custom_json_formatter(obj):
    # Pretty-print JSON with indentation and sorted keys
    return json.dumps(obj, indent=4, sort_keys=True, ensure_ascii=False)

# Register for application/json MIME type
display_formatter.formatters['application/json'].for_type(dict, custom_json_formatter)

# Test the custom formatter
display({"username": "Alice", "age": 28, "interests": ["data science", "painting"]})

内容的提问来源于stack exchange，提问作者Nil