{"id":16128037,"url":"https://github.com/mcanouil/quarto-spotlight","last_synced_at":"2025-07-15T22:31:56.785Z","repository":{"id":85244679,"uuid":"599963298","full_name":"mcanouil/quarto-spotlight","owner":"mcanouil","description":"A Quarto extension for Reveal.js allowing to highlight the current mouse position with a spotlight.","archived":false,"fork":false,"pushed_at":"2024-07-20T21:55:41.000Z","size":26,"stargazers_count":22,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-09T22:04:54.529Z","etag":null,"topics":["quarto","quarto-extension","quarto-pub","quartopub","revealjs","revealjs-plugin"],"latest_commit_sha":null,"homepage":"https://m.canouil.dev/quarto-spotlight/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mcanouil.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"mcanouil","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2023-02-10T09:16:45.000Z","updated_at":"2024-10-06T22:30:45.000Z","dependencies_parsed_at":"2024-05-29T13:21:53.388Z","dependency_job_id":null,"html_url":"https://github.com/mcanouil/quarto-spotlight","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcanouil%2Fquarto-spotlight","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcanouil%2Fquarto-spotlight/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcanouil%2Fquarto-spotlight/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mcanouil%2Fquarto-spotlight/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mcanouil","download_url":"https://codeload.github.com/mcanouil/quarto-spotlight/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226077541,"owners_count":17570163,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["quarto","quarto-extension","quarto-pub","quartopub","revealjs","revealjs-plugin"],"created_at":"2024-10-09T22:01:28.024Z","updated_at":"2024-11-23T17:47:48.027Z","avatar_url":"https://github.com/mcanouil.png","language":"JavaScript","funding_links":["https://github.com/sponsors/mcanouil"],"categories":["JavaScript"],"sub_categories":[],"readme":"# Spotlight Extension For Quarto `revealjs` Format\n\nA plugin for [Reveal.js](https://github.com/hakimel/reveal.js) allowing to highlight the current mouse position with a spotlight.\n\n## Installing\n\n```bash\nquarto add mcanouil/quarto-spotlight\n```\n\nThis will install the extension under the `_extensions` subdirectory.\nIf you're using version control, you will want to check in this directory.\n\n## Usage\n\nSimply add the extension to the list of reveal plugins like:\n\n```yaml\nformat:\n  revealjs: default\n  spotlight:\n    # set pointer configuration options here\nrevealjs-plugins:\n  - spotlight\n```\n\n## Options\n\nYou can control the appearance of the pointer by passing some additional options under a `spotlight` key.\n\n| Option                       | Description                                                                                           |\n| ---------------------------- | ----------------------------------------------------------------------------------------------------- |\n| `size`                       | size of the spotlight. Default is `60`.                                                               |\n| `lockPointerInsideCanvas`    | Locks the mouse pointer inside the presentation. Default is `false`.                                  |\n| `toggleSpotlightOnMouseDown` | Toggle spotlight by holding down the mouse key. Default is `true`.                                    |\n| `spotlightOnKeyPressAndHold` | The key code pressed and held to turn on spotlight, disabled when set to false. Default is `false`.   |\n| `spotlightCursor`            | The cursor when spotlight is on. Can be \"crosshair\". Default is `none`.                               |\n| `presentingCursor`           | The cursor when spotlight is off and in presentation mode. Can be \"default\". Default is `none`.       |\n| `initialPresentationMode`    | Enable presentation mode, will also be true if toggleSpotlightOnMouseDown is true. Default is `true`. |\n| `disablingUserSelect`        | Disable selecting in presentation mode. Default is `true`.                                            |\n| `fadeInAndOut`               | Transition duration in ms to enable fade in and out, disabled when set to false. Default is `100`.    |\n| `useAsPointer`               | Enable pointer mode. Default is `false`.                                                              |\n| `pointerColor`               | Set pointer colour if pointer mode is enabled. Default is `red`.                                      |\n\n## Example\n\nHere is the source code for a minimal example: [example.qmd](example.qmd).  \nView an example presentation at \u003chttps://m.canouil.dev/quarto-spotlight\u003e.\n\n---\n\n[Spotlight - Reveal.js Plugin](https://github.com/denniskniep/reveal.js-plugin-spotlight) by Dennis Kniep ([@denniskniep](https://github.com/denniskniep)) under Apache License 2.0.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcanouil%2Fquarto-spotlight","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmcanouil%2Fquarto-spotlight","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmcanouil%2Fquarto-spotlight/lists"}