highlight.js provides inline text annotation highlights for web pages.
With highlight.js, you can interactively highlight text on a web page and get a shareable link with your saved highlights.
To start using highlight.js, first copy the script and style sheet onto your website:
git clone https://github.com/capjamesg/highlight.js
cp highlight.js/highlight.js YOUR_SITE_ASSETS_FOLDER
cp highlight.js/annotate.css YOUR_SITE_ASSETS_FOLDER
Next, embed the highlight.js CSS and JavaScript files on your website:
<link rel="stylesheet" href="YOUR_SITE_ASSETS_FOLDER/annotate.css">
<script src="YOUR_SITE_ASSETS_FOLDER/highlight.js"></script>
Now you are ready to use the script!
To annotate, press Control + K
at the same time. Then, highlight any text on the page that you want to appear in your shared link. You can do this by dragging your mouse over any text on the page. A box will appear in the top right corner that tracks how many highlights you have created in your session.
When you are done, press Copy URL
to copy the URL with your highlights to your clipboard. You can then paste this URL anywhere to share your highlights.
Open the following URL:
https://wiki.jamesg.blog/index.php?title=TV_Shows#w=t,The%20Simpsons%20Season%2033%20Finale,#text=Seinfeld,#text=Coronation%20Street,#text=Silicon%20Valley
This URL highlights four TV shows on my TV show watch list:
- The Simpsons Season 33 Finale
- Seinfeld
- Coronation Street
- Silicon Valley
The image below shows the highlights in the above URL displayed on a page:
To highlight an entire paragraph on a page, check out fragmention.js.
If you have a suggestion on how to improve this script, please feel free to file an issue so improvements can be discussed before being turned into Pull Requests.
This code is released into the public domain.
- capjamesg