Git Product home page Git Product logo

hypothesis's Introduction

Hypothesis

Integrate your Hypothesis account with Roam!

Usage

This extension includes Roam Command Palette & SmartBlock commands designed to pull in annotations from Hypothes.is. To get started,

API Token

  1. Register for a free user account at Hypothes.is
  2. Copy your free developer key from Hypothes.is which can be obtained at: https://hypothes.is/account/developer
  3. Add the Hypothesis User Token API in your Roam Depot Settings

Highlights Format

The output format for the block for a highlight can be customized in Roam Depot Settings.

The template will replace HIGHLIGHT for where the highlight text should appear and URL for where the URL to the hypothesis annotation.

Notes Format

The output format for the block for a note can be customized in Roam Depot Settings.

The template will replace NOTE for where the note text should appear and URL for where the URL to the hypothesis annotation.

Commands

The following commands will then be available to you.

Import Public Hypothesis Annotations

Looks at the text in the current block for a URL to an article. For that URL retrieves annotations from all users and inserts them as child blocks, with a limit of 20.

The Smartblock Command equivalent is <%HYPOTHESISPUBLICANNOTATIONS%>, which takes in an optional limit parameter.

Import Private Hypothesis Annotations

Looks at the text in the current block for a URL to an article. For that URL retrieves "my" annotations and inserts them as child blocks, with a limit of 20.

The Smartblock Command equivalent is <%HYPOTHESISINSERTANNOTATIONS%>, which takes in an optional limit parameter.

Open Site in Hypothesis

Looks at the text in the current block for a URL. It opens the URL in Hypothes.is for annotation.

The Smartblock Command equivalent is <%HYPOTHESISOPENSITE%>.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.