/roam-highlighter

Chrome highlighter that quickly and easily puts your highlights into Roam format for easy pasting into your notes.

Primary LanguageJavaScript

roam-highlighter

Follow instructions in the Video (Linking it Here) under the Getting Started section below to install Chrome Extension on your machine with my roam-highlighter code. Very easy to do! Video is under 8 minutes and will have you up and running! Looking for any and all feedback from folks!

How to Use the Highlighter

  • Install Chrome Extension on local machines via instructional Video below
  • Press the Highlighter icon in Chrome Extensions toolbar to activate it (only applies to the Tab you click it on)
  • Select text in an article you want to highlight and press Ctrl + X ("cut" command on Windows) to highlight.
  • If you just want a quick way to grab a Link to the page in the [ Page title ] (URL) format for Roam without having to highlight anything, simply use Ctrl + X without any text selected or Highlights and it will just copy that to the clipboard for you.
  • Click a highlight if you want to remove it later.
  • Everything auto updates and copies to clipboard anytime you make any changes.
  • Paste into Roam and the formatting will do the work for you.
  • If you don't like the way it handles Line Breaks by default, there are 4 options to quickly switch between.
  • Simple go back to your webpage and press Ctrl + V ("paste" command on windows) to bring up an options input.
  • Four Options for handling line breaks within each selected highlight by the user (see Demo #3 below)
    1. Set to 0 (Default) if you want line breaks (e.g., each paragraph) to create new bullets at same hierarchy/level
    2. Set to 1 if you want line breaks (e.g., each paragraph) to create new bullets, but nested underneath the first "paragraph" in the highlight
    3. Set to 2 if you want line breaks (e.g., each paragraph) to be in same bullet with Ctrl + Enter "soft line breaks" like Ctrl + Shift + V does in browser pasting
    4. Set to 3 if you want line breaks (e.g., each paragraph) to be replaced with a "space" and simply concatenated into a single bullet and without any line breaks

Note: if you highlight something will turn to yellow... then if you click that highlight it will remove it... BUT if you now select text within a Highlight yellow, it will turn it blue and will now tag that piece in double brackets [[selection]] so that when pasted into Roam it creates a backlink/page/tag!! so you can pre tag/link stuff straight from page. If you click any of the blue highlights, it will remove it from being tagged and turn it back to Yellow.

Demo 1 (real quick/simple)

Demo 2

Demo 3 (showing options for handling line breaks)

Demo 4 (Select word(s) within a highlight to mark for [[page linking]])

Getting Started

Video on how to create Chrome Extension for Roam-Highlighter started with highlight.

Then more stuff here.

  • Download repository
  • Follow the video above for complete instructions on creating Chrome Extension
  • Video also has a demo of the product (although when it wasn't as good a few days ago)
  • Review the GIF Demos above to get an idea of how it works

NOTE EVERYTHING BELOW IS A PLACEHOLDER THAT I NEED TO FILL OUT TO FINISH README

Prerequisites

What things you need to install the software and how to install them

Give examples

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments