https://github.com/DanilaFe/matrix-highlight

A decentralized and federated way of annotating the web based on Matrix.
https://github.com/DanilaFe/matrix-highlight

Last synced: about 2 months ago
JSON representation

A decentralized and federated way of annotating the web based on Matrix.

• Host: GitHub
• URL: https://github.com/DanilaFe/matrix-highlight
• Owner: DanilaFe
• License: apache-2.0
• Created: 2021-12-14T21:19:01.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-04-23T03:38:44.000Z (over 1 year ago)
• Last Synced: 2024-11-16T14:02:36.493Z (about 2 months ago)
• Language: TypeScript
• Size: 5.48 MB
• Stars: 140
• Watchers: 6
• Forks: 3
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-matrix - Repo

README

        
# Matrix Highlight

A decentralized and federated way of annotating the web based on [Matrix](https://matrix.org).

Watch a quick demo video below, or read the [introductory post](https://danilafe.com/blog/introducing_highlight/).

If you're on Matrix, come chat with us at [`#matrix-highlight:matrix.danilafe.com`](https://matrix.to/#/#matrix-highlight:matrix.danilafe.com).

![Image](./pictures/mhl_many.png)

## Features

* __Current__: Create and send website annotations over Matrix.

* __Current__: Store data in a decentralized and federated manner.

* __Current__: Share highlights with other users, including those on other servers.

* __Current__: Group annotations together and create multiple annotation groups

* __Current__: Leverage the new [`m.thread` MSC](https://github.com/matrix-org/matrix-doc/blob/gsouquet/threading-via-relations/proposals/3440-threading-via-relations.md) to allow users to comment on and discuss

* __Planned__: Use Matrix's End-to-End encryption to ensure the secure transmission and storage of highlight data.

highlights.

* __Planned__: Use something like [ArchiveBox](https://archivebox.io/) to cache the current version of a website and prevent annotations from breaking.

* __Planned__ Highlight PDFs in addition to web pages.

## Screenshots

__Selecting an expression to highlight__

![Selecting an expression to highlight](./pictures/mhl_tooltip.png)

__Highlighted expression__

![Highlighted expression](./pictures/mhl_highlight.png)

__Highlight comments__

![Highlight comments](./pictures/mhl_comments.png)

__Quote List View__

![Quote List View](./pictures/mhl_quotelist.png)

__User List View__

![User List View](./pictures/mhl_userlist.png)

__Multi-user collaboration__

![Multi-user collaboration](./pictures/mhl_multi.png)

## Demo Video

https://user-images.githubusercontent.com/4361282/146517732-d3205964-7d63-4f35-baae-aeab3a9d178c.mp4

## See Also

Also check out [Populus](https://github.com/opentower/populus-viewer), which is a tool in similar spirit, but with a focus on annotating files.

## Building

The project is a handful of React applications written in TypeScript. It's sufficient to run:

```Bash

yarn install

# Firefox

yarn webpack

# Chrome

yarn webpack --env browser=chrome

```

An (unpacked) extension will be available in `dist/`. Then, you can follow the [Google guide] to

install the unpacked extension in Chrome or Chromium.