https://github.com/knowledgecanvas/extensions
Browser extensions for the Knowledge application
https://github.com/knowledgecanvas/extensions
angular chrome-extension firefox-addon knowledge
Last synced: 6 months ago
JSON representation
Browser extensions for the Knowledge application
- Host: GitHub
- URL: https://github.com/knowledgecanvas/extensions
- Owner: KnowledgeCanvas
- License: apache-2.0
- Created: 2022-06-05T19:43:14.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-16T01:26:40.000Z (over 3 years ago)
- Last Synced: 2024-11-12T06:14:22.945Z (over 1 year ago)
- Topics: angular, chrome-extension, firefox-addon, knowledge
- Language: TypeScript
- Homepage:
- Size: 362 KB
- Stars: 27
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Knowledge Extensions
Chrome extension for the [Knowledge](https://github.com/KnowledgeCanvas/knowledge) application (Firefox extension coming soon!).
[Download for Chrome](https://github.com/KnowledgeCanvas/extensions/releases/tag/v0.1.0)
**Table of Contents**
- [Features](#features)
- [Screenshots](#screenshots)
- [Getting Started](#getting-started)
- [Instructions](#instructions)
- [Build from source](#build-from-source-optional)
# Features
Knowledge Extensions are meant to augment the use of the Knowledge application by making it easier to import sources without leaving the browser. Extensions automatically extract content from the active tab and allows user customization before sending that data to the Knowledge application.
## Feature Roadmap
- [ ] Automatic Extraction
- [x] Basic extraction (title, url, icon)
- [x] Topics (keywords) extraction
- [x] [OpenGraph](https://ogp.me/) extraction (description, thumbnail, type, etc.)
- [x] Twitter tag extraction
- [x] Highlighted text extraction
- [ ] Article extraction
- [ ] Code blocks extraction
- [ ] YouTube video metadata extraction
- [x] Mark source `Important` on import
- [ ] Sync with `Knowledge` for existing sources
- [ ] Show source details in extension if it exists in `Knowledge`
- [ ] Show related/similar sources
- [ ] Persist highlights and other markup
- [ ] Save as PDF on Import
- [ ] Set a custom port for communicating with `Knowledge`
# Screenshots
# Getting Started
**Note:** Extensions only work with `Knowledge` version 0.6.0 or higher. `Knowledge` must be opened and `Browser Extensions` must be enabled in the `Import Settings` menu. Extensions are side-loaded using developer mode in Chrome for now. We are still investigating the viability of hosting the extension on the Chrome Web Store.
## Instructions
1. Download the prebuilt zip, or build from source ([see below](#build-from-source))
2. Ensure that `Knowledge` version 0.6.0 or higher is installed
3. In `Knowledge`, go to `Settings > Import` and enable "Browser Extensions"
4. In Chrome, navigate to `chrome://extensions`
5. Enable "Developer mode"
6. Click "Load unpacked"
7. Select the `knowledge-extensions` folder
- When building from source, this will be under `/dist/knowledge-extensions`
8. (Optional): Click the Chrome Extensions button and pin `Knowledge Extension` for quick access
## Build from source (Optional)
1. Clone this repository
2. Delete the `.yarnrc.yml` file. This will be replaced in the next steps
3. Run the following commands to setup yarn and install dependencies:
```shell
yarn set version berry
yarn plugin import typescript
```
4. Edit the `.yarnrc.yml` file and add `nodeLinker: node-modules` as the first line. The `.yarnrc.yml` file should have the following contents:
```yaml
nodeLinker: node-modules
plugins:
- path: .yarn/plugins/@yarnpkg/plugin-typescript.cjs
spec: "@yarnpkg/plugin-typescript"
yarnPath: .yarn/releases/yarn-3.2.1.cjs
```
5. Run `yarn install` followed by `yarn build`
6. The final build will be located in `dist/knowledge-extensions`
7. (Optional) To clean the `dist` directory, run `yarn clean`. To remove all `node` dependencies, run `yarn purge`