Data

Tools

Indexes

Applications

Experiments

Open Source Science

quarto-spotlight

A Quarto extension for Reveal.js allowing to highlight the current mouse position with a spotlight.

https://github.com/mcanouil/quarto-spotlight

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (6.9%) to scientific vocabulary

Keywords

quarto quarto-extension quarto-pub quartopub revealjs revealjs-plugin
Last synced: 6 months ago · JSON representation ·

Repository

A Quarto extension for Reveal.js allowing to highlight the current mouse position with a spotlight.

Basic Info
Statistics
  • Stars: 26
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 3
Topics
quarto quarto-extension quarto-pub quartopub revealjs revealjs-plugin
Created about 3 years ago · Last pushed 9 months ago
Metadata Files
Readme Funding License Citation

README.md

Spotlight Extension For Quarto revealjs Format

A plugin for Reveal.js allowing to highlight the current mouse position with a spotlight.

Installing

bash quarto add mcanouil/quarto-spotlight

This will install the extension under the _extensions subdirectory. If you're using version control, you will want to check in this directory.

Usage

Simply add the extension to the list of reveal plugins like:

yaml format: revealjs: default spotlight: # set pointer configuration options here revealjs-plugins: - spotlight

Options

You can control the appearance of the pointer by passing some additional options under a spotlight key.

| Option | Description | | ---------------------------- | ----------------------------------------------------------------------------------------------------- | | size | size of the spotlight. Default is 60. | | lockPointerInsideCanvas | Locks the mouse pointer inside the presentation. Default is false. | | toggleSpotlightOnMouseDown | Toggle spotlight by holding down the mouse key. Default is true. | | spotlightOnKeyPressAndHold | The key code pressed and held to turn on spotlight, disabled when set to false. Default is false. | | spotlightCursor | The cursor when spotlight is on. Can be "crosshair". Default is none. | | presentingCursor | The cursor when spotlight is off and in presentation mode. Can be "default". Default is none. | | initialPresentationMode | Enable presentation mode, will also be true if toggleSpotlightOnMouseDown is true. Default is true. | | disablingUserSelect | Disable selecting in presentation mode. Default is true. | | fadeInAndOut | Transition duration in ms to enable fade in and out, disabled when set to false. Default is 100. | | useAsPointer | Enable pointer mode. Default is false. | | pointerColor | Set pointer colour if pointer mode is enabled. Default is red. |

Example

Here is the source code for a minimal example: example.qmd.
View an example presentation at https://m.canouil.dev/quarto-spotlight.

Spotlight - Reveal.js Plugin by Dennis Kniep (@denniskniep) under Apache License 2.0.

Owner

  • Name: Mickaël Canouil
  • Login: mcanouil
  • Kind: user
  • Location: Lille, France

Biostatistician, Ph. D. (& cinephile) @RLille User Group Organiser

Citation (CITATION.cff) 

cff-version: 1.2.0
title: "Spotlight Extension for Quarto"
message: "If you use this project, please cite it as below."
type: software
authors:
  - family-names: "Canouil"
    given-names: "Mickaël"
    orcid: "https://orcid.org/0000-0002-3396-4549"
repository-code: "https://github.com/mcanouil/quarto-spotlight"
url: "http://m.canouil.dev/quarto-spotlight/"
license: "MIT"
date-released: "2025-04-05"
version: 1.0.2

GitHub Events

Total
  • Release event: 1
  • Watch event: 4
  • Delete event: 3
  • Push event: 9
  • Pull request event: 4
  • Create event: 3
Last Year
  • Release event: 1
  • Watch event: 4
  • Delete event: 3
  • Push event: 9
  • Pull request event: 4
  • Create event: 3

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 2
  • Total pull requests: 4
  • Average time to close issues: 17 days
  • Average time to close pull requests: less than a minute
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 2
  • Average time to close issues: 26 days
  • Average time to close pull requests: less than a minute
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • sammo3182 (1)
  • mcanouil (1)
Pull Request Authors
  • mcanouil (6)
  • github-actions[bot] (1)
Top Labels
Issue Labels
Difficulty: [1] Novice (1) Priority: [1] Low (1) Type: CI/CD :robot: (1)
Pull Request Labels
Type: CI/CD :robot: (4) Type: Enhancement :bulb: (3)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
proxy.golang.org: github.com/mcanouil/quarto-spotlight
  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 6.4%
Average: 6.7%
Dependent repos count: 6.9%
Last synced: 6 months ago

Dependencies

.github/workflows/release.yml actions