A Markdown-Jekyll Powershell script to simplify pasting images into a Jekyll blog post. Updated

Update: Can specify the image width when clipboard is saved and does a collision check and fix wrt the image filename.

You can paste an image directly into some Markdown editors, but this often results in the image being saved in the root folder of the project with a bland filename. This script allows you to save the image to a specified media folder with a meaningful filename and generates the appropriate Markdown syntax for easy inclusion in your documents. It now also makes sure the image filename is unique.

Usage

  • Context: Creating a Jekyll blog post using a Markdown editor
  • Assuming: The script SaveClipboardImage.ps1 is in the scripts folder
    • The Script SaveClipboardImage.ps1 is listed below.
    • Can start paste of an image from the clipboard into a Jekyll post
    • Prompts for image name and width (px)
    • Stores the modified image in /media.
    • Liquid code for displaying image in a post is then generated and copied to the clipboard for pasting into the post.
      Includes raw markdown for image as well.
    • Needs image.html in /_includes for this to work.
  • Requirement: The custom component image.html
  • Copy: The image to the clipboard. I usually use the Windows Snipping Tool.
  • Run: .\scripts\SaveClipboardImage.ps1
  • NB: You will get: ❌ No image found in clipboard. if that is the situation.
  • A typical session:

Note: The raw markdown link for the image is supplied plus the one using the include file image.html. Use the first to view in the editor. Use the second for deploy Jekyll blog post as it implements special features making the layout wrt the image sensible on a phone. (See previous posts.)

Earlier blog posts wrt the image paste script


Nb: Some repetition in what follows.

About the Script

  • Copy image on clipboard to /media folder (or specified folder)
  • Prompt for the saved image width in pixels (defaulting to the original width), preserving its aspect ratio
  • Prompt for filename (with default based on date/time)
  • Append a random four-digit suffix to the filename if it already exists
  • Output Markdown syntax to reference the image
  • Markdown is copied to clipboard for easy pasting
  • Provides 2 formats for image reference
    • Standard Markdown
    • Custom resizing image macro for a Jekyll site
    • Having both allows the image to viewed in the editor’s preview.
      • Can delete or comment out the Markdown syntax version.

Usage:

the script, as below is saved to ` .\scripts\SaveClipboardImage.ps`
Copy an image to clipboard, then run the script from a PowerShell terminal:

   .\scripts\SaveClipboardImage.ps1 [-MediaFolder <path>]

The Script

# SaveClipboardImage.ps1
#
# Copy image on clipboard to /media folder 
# Prompt for the saved image width, preserving its aspect ratio
# Output Markdown syntax to reference the image
# Markdown is copied to clipboard for easy pasting
# Provides 2 formats for image reference
# - Standard Markdown
# - Resizing image macro for Jekyll site
#      - Ref [Jekyll: Rendering on a Mobile Part 1](https://davidjones.sportronics.com.au/web/Jekyll-Rendering_on_a_Mobile-rel-web.html)
# Usage:
#   .\SaveClipboardImage.ps1 [-MediaFolder <path>]

param(
    [string]$MediaFolder = "media"
)

# Ensure media folder exists
if (-not (Test-Path $MediaFolder)) {
    New-Item -ItemType Directory -Path $MediaFolder | Out-Null
}

# Get image from clipboard
Add-Type -AssemblyName System.Windows.Forms
$image = [System.Windows.Forms.Clipboard]::GetImage()

if ($null -eq $image) {
    Write-Host "❌ No image found in clipboard."
    exit
}

# Prompt for a positive width, defaulting to the original width
do {
    $inputWidth = Read-Host "Enter image width in pixels (default: $($image.Width))"
    if ([string]::IsNullOrWhiteSpace($inputWidth)) {
        $width = $image.Width
        $validWidth = $true
    } else {
        $width = 0
        $validWidth = [int]::TryParse($inputWidth, [ref]$width) -and $width -gt 0
        if (-not $validWidth) {
            Write-Host "Please enter a positive whole number for the width."
        }
    }
} while (-not $validWidth)

# Generate default filename
$defaultFileName = "image-$((Get-Date).ToString('yyyyMMdd-HHmmss')).png"

# Prompt user for filename (default shown in brackets)
$inputFileName = Read-Host "Enter filename (default: $defaultFileName)"
if ([string]::IsNullOrWhiteSpace($inputFileName)) {
    $fileName = $defaultFileName
} else {    
    # Ensure .png extension if missing
    if (-not $inputFileName.EndsWith(".png")) {
        $inputFileName += ".png"
    }
    $fileName = $inputFileName
}

# Resize only when needed, preserving the original aspect ratio
$resizedImage = $null
try {
    $imageToSave = $image
    if ($width -ne $image.Width) {
        $height = [Math]::Max(1, [Math]::Round([double]$image.Height * $width / $image.Width))
        if ($height -gt [int]::MaxValue) {
            throw "The requested width produces an image height that is too large."
        }
        $resizedImage = [System.Drawing.Bitmap]::new($width, [int]$height)
        $graphics = [System.Drawing.Graphics]::FromImage($resizedImage)
        try {
            $graphics.CompositingMode = [System.Drawing.Drawing2D.CompositingMode]::SourceCopy
            $graphics.InterpolationMode = [System.Drawing.Drawing2D.InterpolationMode]::HighQualityBicubic
            $graphics.DrawImage($image, 0, 0, $width, [int]$height)
        } finally {
            $graphics.Dispose()
        }
        $imageToSave = $resizedImage
    }

    $baseFileName = $fileName.Substring(0, $fileName.Length - 4)
    $suffixes = $null
    $suffixIndex = 0
    while ($true) {
        $filePath = Join-Path $MediaFolder $fileName
        $savePath = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($filePath)
        try {
            $stream = [System.IO.File]::Open($savePath, [System.IO.FileMode]::CreateNew, [System.IO.FileAccess]::Write)
            break
        } catch [System.IO.IOException] {
            if (-not (Test-Path -LiteralPath $filePath)) {
                throw
            }
            if ($null -eq $suffixes) {
                $suffixes = @(0..9999 | Get-Random -Count 10000)
            }
            if ($suffixIndex -ge $suffixes.Count) {
                throw "No available four-digit suffix for '$baseFileName.png'."
            }
            $fileName = "{0}-{1:D4}.png" -f $baseFileName, $suffixes[$suffixIndex++]
        }
    }
    try {
        $imageToSave.Save($stream, [System.Drawing.Imaging.ImageFormat]::Png)
    } finally {
        $stream.Dispose()
    }
} finally {
    if ($null -ne $resizedImage) {
        $resizedImage.Dispose()
    }
    $image.Dispose()
}


# Output Markdown syntax
$markdown = "![${fileName}](/${MediaFolder}/${fileName}"
$markdownAlt = "{% include image.html imagefile = ""/${MediaFolder}/${fileName}"" tag = ""${fileName}"" alt = ""${fileName}""  %}"
$merged = "$markdown`n$markdownAlt"


write-host ""
Write-Host  -ForegroundColor DarkMagenta  "Image saved to $filePath"
write-host ""
Write-Host -ForegroundColor Blue  "Markdown:"
Write-Host -ForegroundColor Green  $merged
Write-Host -ForegroundColor Blue "Copied to clipboard."
# $merged | Set-Clipboard
write-host ""
Write-Host -ForegroundColor Red "Paste Markdown from clipboard."
Write-Host -ForegroundColor Red "Make sure that the tag is unique for the page."
write-host ""

Jekyll Include Macro Format

the line of code $markdownAlt = uses the custom Jekyll image.html include to render images with resizing capabilities as discussed at Jekyll: Rendering on a Mobile Part 1. This displays a .png image normally as part of a Markdown-Jekyll page in desktop resolutions using the image’s size, but on a smaller screen such as on a phone it is rendered such that its width is the width of the phone. This means that the text rendered on the phone is readable without having to zoom in as otherwise everything is shrunk so that the largest image width fits.

Comment

Whilst you can directly paste an image into some Markdown editors, having the image saved in the media folder and referenced via Markdown syntax ensures better organization and portability of your content. When you do directly paste an image, it is saved in the root folder of the project with a bland filename, which is not ideal.

This script enables you to paste an image into a specified folder, prompt for a meaningful filename, and generate the appropriate Markdown syntax for easy inclusion in your documents.

Nb: the tag property needs to be different for each image on a page, when using the Jekyll include macro. This may need to be manually modified once the Markdown is pasted into the editor.

Making life easier! 😃

Footnote

Had a problem showing one line of code in a code block. This is the line starting with $markdownAlt= as there was an interpretation of the Jekyll code there by the Build, rather than displaying it as-is. It was fixed by adding raw and endraw tags around that line.
Note that the text for these tags is proceeded by openbrace-percent characters and followed by percent-closebrace characters.

Further

In Visual Studio there is an add-in called Copy as HTML which allows copying code with syntax highlighting to the clipboard. This is useful for blog posts. Also, in VS Code there is an extension called Copy Markdown as HTML which does similar.For example:


{% raw %}
# Output Markdown syntax
$markdown = "![${fileName}](/${MediaFolder}/${fileName}"
$markdownAlt = "{% include image.html imagefile = ""/${MediaFolder}/${fileName}"" tag = ""${fileName}"" alt = ""${fileName}""  %}"
$merged = "$markdown`n$markdownAlt"
{% endraw %}

The code block above was generated by opening this page in Visual Studio 2022, selecting the corresponding code lines from The Script section above, and choose Copy as HTML from the Edit menu. The resulting HTML code was pasted directly into this blog post unqualified and unadulterated just above as HTML code. The OpenBrace and CloseBrace characters were replaced with their HTML escape codes namely &#123; and &#125; respectively. And wrt a phone, no need to worry about its width. The post text is full width and the code block here is horizontally scrollable if wider. I’ll use this in future for code in posts


 TopicSubtopic
<  Prev:   Blazor Apps
   
 This Category Links 
Category:Web Sites Index:Web Sites