Markdown Clip

日本語版の「README」はこちらから

A Visual Studio Code extension that provides functionality to convert Markdown to HTML and copy it to the clipboard.

TOC

• Installation
• Example
• Features
• Usage
• Explanation
• Settings
• Credits
• Used Plugins
• Acknowledgments

Installation

Enter "Markdown Clip" in the VS Code marketplace.

Example

Converts the entire Markdown text of a file to HTML and automatically copies it to the clipboard.

Features

• Convert selected Markdown text to HTML
• If no range is selected, convert the entire Markdown file
• Automatically paste the converted HTML to the clipboard

Usage

Explanation

"Markdown Clip" is a VS Code extension that converts Markdown to HTML and copies it to the clipboard.

1. Open a Markdown file
2. Select the range you want to convert (optional)
3. Execute the command using any method
4. HTML is copied to the clipboard

// Markdown Text
**Text**

// HTML converted and pasted to clipboard
<strong>Text</strong>

Settings

Remove Heading ID

• true : Disables automatically generated heading IDs (<h1 id='Title'>)
• false (Default): Keep heading IDs

// Markdown Text (with markdown-it-attrs applied)
# Test {#test}

// If setting is true
<h1 id="test">Test</h1>

// If setting is false
<h1 id="test" id="Test-test">Test</h1>

Remove VSCode Attributes

• true: Disables automatically generated VSCode attributes (<h1 data-line="number", class="code-line", dir="auto">)
• false (Default): Keep VSCode attributes

// Markdown Text
# Test

// If setting is true
<h1>Test</h1>

// If setting is false
<h1 data-line="0" class="code-line" dir="auto">Test</h1>

Plugin Settings

ON/OFF Function

• Markdown-it-attrs: Enable
  • true (Default): When custom attributes ({#id .class} format) are specified, apply them to the HTML tag.
  • false: The plugin is disabled, and custom IDs ({#id} format) are no longer reflected.

// Markdown Text
# Test {.test}

// If setting is true
<h1 class="test">Test</h1>

// If setting is false
<h1>Test {.test}</h1>

Detailed Settings

• Markdown-it-attrs: Options
  • Edit in settings.json: You can edit the detailed settings for each plugin.

The following is the default setting:

{
    "leftDelimiter": "{",    // Opening delimiter
    "rightDelimiter": "}",   // Closing delimiter
    "allowedAttributes": []  // Allowed attributes (No notation means all are allowed)
}

Credits

The icon displayed in the VS Code extension is a combination of the following two images:

Used Plugins

• copy-paste
• markdown-it-attrs

Acknowledgments

In developing this project, we referenced the following open-source software. We would like to express our gratitude:

• qjebbs/vscode-markdown-extended

For additional licensing information, please see the NOTICE file.