Skip to content

KnowledgeCanvas/extensions

Repository files navigation

Knowledge Extensions

Chrome extension for the Knowledge application (Firefox extension coming soon!).

Download for Chrome

Table of Contents

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
    • Basic extraction (title, url, icon)
    • Topics (keywords) extraction
    • OpenGraph extraction (description, thumbnail, type, etc.)
    • Twitter tag extraction
    • Highlighted text extraction
    • Article extraction
    • Code blocks extraction
    • YouTube video metadata extraction
  • 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

image

image

image

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)
  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 <root>/dist/knowledge-extensions
  1. (Optional): Click the Chrome Extensions button and pin Knowledge Extension for quick access

image

image

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:
yarn set version berry
yarn plugin import typescript
  1. Edit the .yarnrc.yml file and add nodeLinker: node-modules as the first line. The .yarnrc.yml file should have the following contents:
nodeLinker: node-modules

plugins:
  - path: .yarn/plugins/@yarnpkg/plugin-typescript.cjs
    spec: "@yarnpkg/plugin-typescript"

yarnPath: .yarn/releases/yarn-3.2.1.cjs
  1. Run yarn install followed by yarn build
  2. The final build will be located in dist/knowledge-extensions
  3. (Optional) To clean the dist directory, run yarn clean. To remove all node dependencies, run yarn purge