Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 3.6 KB

README.md

File metadata and controls

58 lines (37 loc) · 3.6 KB
Raw

Block Share Card Extension for Roam Research

The Block Share Card extension for Roam Research enables users to effortlessly share the currently zoomed-in block as an image, tailored for optimal viewing on mobile and desktop devices.

This extension enhances the user experience by simplifying the sharing process and ensuring content is easily readable on any device.

Screenshots

Desktop View Mobile View

Features

  • Instant Block Sharing: Quickly share any zoomed-in block from your Roam Research page with a single click.
  • Mobile and Desktop Optimization: Choose from two image export options designed for different device displays:
    • Mobile: Creates a narrower image, perfect for viewing on mobile devices.
    • Desktop: Generates a wider image, ideal for desktop screens.

Installation

  1. Open Roam Research and navigate to Roam Depot.
  2. Search for "Block Share Card" in the Roam Depot's search bar.
  3. Click the "Install" button to add the Block Share Card extension to your Roam Research tools.

Usage

Once the extension is installed, you'll find a new sharing icon in the Roam Research toolbar. To use the extension:

  1. Zoom into the block that you wish to share.
  2. Click the sharing icon from the Block Share Card extension.
  3. Select "Mobile" or "Desktop" based on your preference for the image format.
  4. After selection, the image will be automatically downloaded to a specified folder, allowing you to easily access and share it across platforms.
Step Action
1
2
3

Support

For support or to report issues, please visit the GitHub repository for this extension.

Contributions

Contributions are welcome! If you'd like to contribute, please fork the repository and submit a pull request.

Acknowledgements

This project, Block Share Card, builds upon the foundational work done in the Styled Roam project by Jimmy Lv.

I am grateful for the initial concepts and code provided by Styled Roam, which have significantly influenced the development of this extension. Special thanks to Jimmy Lv and all contributors to the Styled Roam project for their pioneering efforts in enhancing the Roam Research user experience.

License

This extension is released under the MIT License. Please see the LICENSE file in the repository for more details.