logseq / logseq/logseq-plugin-samples

Example for adding a shortcut

Open
#10 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
CSS
Stars
383
Forks
97
PR merge metrics
No merged PRs in 30d

Description

Hi! I've been experimenting with a few knowledge bases and tried Logseq for a while. I'm currently on Trilium Notes.

Trilium Notes is very scriptable and allows users to bind keyboard shortcuts to their own JavaScript. I currently have one for "create issue", which creates a note with a particular template (basically to make it an issue for my simple in-Trillium issue tracker).

It would be probably also useful for writers of Logseq plugins to have an example of how to do this properly (especially given that logseq has changeable shortcuts).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the repository's existing plugin samples and the shortcut-related plugin interfaces. Define the expected behavior from the request, then verify that the example demonstrates a JavaScript action bound to a changeable keyboard shortcut; no file or test is named, so the repository structure must be established first.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.