PHP
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
blueprints
CHANGELOG.md
LICENSE
README.md
blueprints.yaml
hypothesis.php
hypothesis.yaml

README.md

Hypothesis Plugin

The Hypothesis Plugin is for Grav CMS and displays the Hypothesis sidebar on your Grav site.

Installation

Installing the Hypothesis plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.

GPM Installation (Preferred)

The simplest way to install this plugin is via the Grav Package Manager (GPM) through your system's terminal (also called the command line). From the root of your Grav install type:

bin/gpm install hypothesis

This will install the Hypothesis plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/hypothesis.

Manual Installation

To install this plugin, just download the zip version of this repository and unzip it under /your/site/grav/user/plugins. Then, rename the folder to hypothesis. You can find these files on GitHub or via GetGrav.org.

You should now have all the plugin files under

/your/site/grav/user/plugins/hypothesis

NOTE: This plugin is a modular component for Grav which requires Grav and the Error and Problems to operate.

Configuration

Before configuring this plugin, you should copy the user/plugins/hypothesis/hypothesis.yaml to user/config/plugins/hypothesis.yaml and only edit that copy.

Here is the default configuration and an explanation of available options:

enabled: true

Page Options (Admin Panel)

'Hypothesis' Admin page option

Page Options (Markdown)

Once the plugin is installed, Grav pages will support the following Page Header/FrontMatter option:

hide_hypothesis: true    # hide Hypothesis sidebar on this page