Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@harvard-lts/mirador-help-plugin

Package Overview
Dependencies
Maintainers
6
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@harvard-lts/mirador-help-plugin

mirador-help-plugin React component

  • 1.2.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
6
increased by100%
Maintainers
6
Weekly downloads
 
Created
Source

mirador-help-plugin

Mirador plugin that adds a help modal window with a list of links. Links are currently Harvard-specific.

Requirements

  • NVM

Setup

  1. Run nvm use to ensure your version of matches that in the .nvmrc file
  2. Run npm i to install dependencies
  3. Use one of the NPM scripts to perform the actions described below.

NPM scripts

The following are some useful scripts can be ran using npm run <script>. A full list can be seen in package.json

ScriptDescription
cleanRemoves the dist directories
buildBuilds the source files into the ./dist directory
serveRuns a local web server where the plugin can be viewed in a vanilla Mirador instance (helpful for testing and development)
testRuns the automated test suites

Installing in Mirador

The mirador-help-plugin requires an instance of Mirador 3. Visit the Mirador wiki to learn how to install an existing plugin and for additional information about plugins.

Package you will need to install:

npm i @harvard-lts/mirador-help-plugin

Contribute

Mirador's development, design, and maintenance is driven by community needs and ongoing feedback and discussion. Join us at our regularly scheduled community calls, on IIIF slack #mirador, or the mirador-tech and iiif-discuss mailing lists. To suggest features, report bugs, and clarify usage, please submit a GitHub issue.

Keywords

FAQs

Package last updated on 11 Oct 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc