Skip to content

zhouhua/obsidian-export-image

Repository files navigation

Obsidian Export Image Plugin

GitHub Release GitHub Downloads (all assets, all releases)

This Obsidian plugin can easily help you export any article as an image.

Features

  • Camera Export any article as an image, with the option to save it as a local image file or copy it to the clipboard.
  • Locked with Pen Support adding watermarks, both text and image watermarks, to protect your copyrights.
  • Identification Card Support adding author information (avatar, name, etc.) for easier sharing and dissemination.
  • Mobile Phone Support outputting images at twice the resolution for clearer display on high PPI devices like smartphones.
  • Straight Ruler Support adjusting the image width to cater to different scenarios, such as exporting images suitable for viewing on mobile devices or ensuring readability when embedding images in articles.
  • Level Slider Offer flexible configuration options with a convenient WYSIWYG (What You See Is What You Get) interface.
  • Bookmark Tabs Support exporting selected content as an image.
  • Card Index Dividers Support for batch exporting all notes in a folder as images.
  • Receipt Support displaying obsidian metadata.

Usage

Note: This plugin works in preview mode.

Now, it works in both preview and read mode.

- Use the command export to image in command palette (Press cmd/ctrl+P to enter the command) to generate a image and download it to your file system.

- Use the command copy as image in command palette (Press cmd/ctrl+P to enter the command) to generate a image and copy it to clipboard, so you can paste in other softwares easily.

Use the command export as a image in command palette (Press cmd/ctrl+P to enter the command) to generate a image. You can download it to your file system, or copy to clipboard.

Also, you can access this function from the editor menu:

Note

Due to device limitations, exporting images on mobile can only be saved to the current vault.

Installation

Obsidian

Search Export Image in community plugins.

Custom Styles

To help experienced users write their own CSS styles, here is the combined DOM structure of the exported image.

<!-- Export Image Root -->
<div class="export-image-root markdown-reading-view">
  <!-- Watermark Container -->
  <div class="markdown-preview-view markdown-rendered export-image-preview-container">
    <!-- Inline Title -->
    <div class="inline-title"></div>
    <!-- Metadata -->
    <div class="metadata-container">
      <div class="metadata-content">
        <!-- Metadata Items -->
        <div class="metadata-property">
          <!-- Metadata Key -->
          <div class="metadata-property-key">
            <!-- Metadata Icon -->
            <span class="metadata-property-icon"></span>
            <!-- Metadata Name -->
            <span class="metadata-property-name"></span>
          </div>
          <!-- Metadata Value -->
          <div class="metadata-property-value"></div>
        </div>
      </div>
    </div>
    
    <!-- Note Content -->
    <div>...</div>
  </div>
  
  <!-- Author Info -->
  <div class="user-info-container">
    <!-- Author Avatar -->
    <div class="user-info-avatar"></div>
    <div>
      <!-- Author Name -->
      <div class="user-info-name"></div>
      <!-- Extra Info -->
      <div class="user-info-remark"></div>
    </div>
  </div>
</div>

Special Thanks

My Other Obsidian Plugins

About

Easily convert your article to image.

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •