{"id":13769626,"url":"https://github.com/DanilaFe/matrix-highlight","last_synced_at":"2025-05-11T02:32:57.360Z","repository":{"id":38951173,"uuid":"438403031","full_name":"DanilaFe/matrix-highlight","owner":"DanilaFe","description":"A decentralized and federated way of annotating the web based on Matrix.","archived":false,"fork":false,"pushed_at":"2023-04-23T03:38:44.000Z","size":5751,"stargazers_count":142,"open_issues_count":23,"forks_count":3,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-15T17:47:17.817Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DanilaFe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-12-14T21:19:01.000Z","updated_at":"2025-04-04T12:04:35.000Z","dependencies_parsed_at":"2023-02-12T07:16:42.425Z","dependency_job_id":"b5ddbc7d-8673-4da9-a9f9-412f0e3136a9","html_url":"https://github.com/DanilaFe/matrix-highlight","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DanilaFe%2Fmatrix-highlight","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DanilaFe%2Fmatrix-highlight/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DanilaFe%2Fmatrix-highlight/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DanilaFe%2Fmatrix-highlight/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DanilaFe","download_url":"https://codeload.github.com/DanilaFe/matrix-highlight/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253507168,"owners_count":21919162,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T17:00:29.615Z","updated_at":"2025-05-11T02:32:56.765Z","avatar_url":"https://github.com/DanilaFe.png","language":"TypeScript","funding_links":[],"categories":["Annotation"],"sub_categories":[],"readme":"# Matrix Highlight\nA decentralized and federated way of annotating the web based on [Matrix](https://matrix.org).\nWatch a quick demo video below, or read the [introductory post](https://danilafe.com/blog/introducing_highlight/).\nIf you're on Matrix, come chat with us at [`#matrix-highlight:matrix.danilafe.com`](https://matrix.to/#/#matrix-highlight:matrix.danilafe.com).\n\n![Image](./pictures/mhl_many.png)\n\n## Features\n* __Current__: Create and send website annotations over Matrix.\n* __Current__: Store data in a decentralized and federated manner.\n* __Current__: Share highlights with other users, including those on other servers.\n* __Current__: Group annotations together and create multiple annotation groups\n* __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\n* __Planned__: Use Matrix's End-to-End encryption to ensure the secure transmission and storage of highlight data.\nhighlights.\n* __Planned__: Use something like [ArchiveBox](https://archivebox.io/) to cache the current version of a website and prevent annotations from breaking.\n* __Planned__ Highlight PDFs in addition to web pages.\n\n## Screenshots\n__Selecting an expression to highlight__\n![Selecting an expression to highlight](./pictures/mhl_tooltip.png)\n\n__Highlighted expression__\n![Highlighted expression](./pictures/mhl_highlight.png)\n\n__Highlight comments__\n![Highlight comments](./pictures/mhl_comments.png)\n\n__Quote List View__\n![Quote List View](./pictures/mhl_quotelist.png)\n\n__User List View__\n![User List View](./pictures/mhl_userlist.png)\n\n__Multi-user collaboration__\n![Multi-user collaboration](./pictures/mhl_multi.png)\n\n## Demo Video\nhttps://user-images.githubusercontent.com/4361282/146517732-d3205964-7d63-4f35-baae-aeab3a9d178c.mp4\n\n## See Also\nAlso check out [Populus](https://github.com/opentower/populus-viewer), which is a tool in similar spirit, but with a focus on annotating files.\n\n## Building\nThe project is a handful of React applications written in TypeScript. It's sufficient to run:\n\n```Bash\nyarn install\n\n# Firefox\nyarn webpack\n\n# Chrome\nyarn webpack --env browser=chrome\n```\n\nAn (unpacked) extension will be available in `dist/`. Then, you can follow the [Google guide] to\ninstall the unpacked extension in Chrome or Chromium.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDanilaFe%2Fmatrix-highlight","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDanilaFe%2Fmatrix-highlight","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDanilaFe%2Fmatrix-highlight/lists"}