Skip to content

README.md

Latest commit

 

History

History
100 lines (68 loc) · 4.32 KB

README.md

File metadata and controls

100 lines (68 loc) · 4.32 KB

Better Embedded Canvas - Obsdian Plugin

latest-version current-downloads current-stars open-issues

Give your embedded canvas better display and interactivity.

embedded-canvas-2.png

⤿ Theme: Adwaita (title bar). Other plugin: Advanced Canvas.

Note

Although this plugin already fulfills the need for a full preview of embedded canvas, I still strongly support including this feature as a built-in feature. Visit here to give your support.

🚀 Features

  • Give embedded canvas the same look as canvas view.
  • Navigate using panning and zooming to move across the canvas.
  • Adjust the height of the embedded canvas in the note.
  • Work on both page preview and canvas.
  • Display embedded canvas on exported PDF.
  • Support Advanced Canvas plugin.

📦 Installation

  • Manual
    • Create a folder named better-embedded-canvas under YOUR_VAULT_NAME/.obsidian/plugins.
    • Place manifest.json, main.js, and style.css from the latest release into the folder.
    • Enable it through the "Community plugin" setting tab.
  • In-app
    • Open settings.
    • Choose "Community plugins" setting tab.
    • Turn off "Restricted mode" if it was enabled before.
    • Click "Browse" at "Community plugins" item.
    • Type "Better Embedded Canvas" in the search box.
    • Install and enable it.
  • Using BRAT.

✍️ Usage

Embedding canvas into your note

Use internal link prefixed with an exclamation mark (!) to embed a canvas. For example:

![[My canvas.canvas]]

You can also adjust the height of the canvas by adding a bar (|) and number to the link destination. For example:

![[My canvas.canvas|500]]

Note

The minimum height of an embedded canvas is 300. The height adjusted below 300 will be rounded up to 300.

Interacting with embedded canvas

You can interact with an embedded canvas in the same way as you do with a full canvas view. If you prefer no interaction, you can disable it by selecting hand pointer iconed button in the upper-right corner.

no-interaction-canvas.png

To learn how to interact with canvas, refer here.

Toggle canvas name

By default, the name of embedded canvas is displayed as embed title. You can hide it by going to Settings → Better Embedded Canvas, then select Show canvas name and disable it.

⚠️ Limitation

Embedded canvas cannot be edited directly. To do that, open the canvas directly.

🐞 Known issues

  • Embedded canvas nodes are not positioned properly in exported PDF.

©️ Attribution

This plugin includes some of the type definitions developed by Michael Naumov, Fevol, and the others at Obsidian Typings, with some adjustments. All their works are licensed under MIT.

🙏 Acknowledgment

Thanks to: