logseq-plugin-sdk

Develop and test Logseq plugins using the JavaScript SDK.

44.4k|2.8k|Updated May 23, 2020
One-click install
npx skills add https://github.com/logseq/logseq --skill logseq-plugin-sdk
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: logseq-plugin-sdk
Source: https://github.com/logseq/logseq/tree/main/libs
Command: npx skills add https://github.com/logseq/logseq --skill logseq-plugin-sdk

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @logseq/libs, webpack, parcel, pnpm, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill simplifies the process of building, testing, and reviewing Logseq plugins by providing comprehensive SDK support and development tools.

Core Features & Use Cases

  • Plugin Creation and Debugging: Facilitates writing, upgrading, and debugging Logseq plugins with integrated SDK APIs.
  • Extending Functionality: Supports registering UI components, commands, properties, and queries efficiently.
  • Use Case: A developer wants to create a custom command in Logseq; this Skill provides the APIs and examples to quickly implement and test it.

Quick Start

Use the SDK to register a slash command that inserts "Hello World" into the editor.

Frequently Asked Questions about logseq-plugin-sdk

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I develop and debug Logseq plugins efficiently?

You can develop Logseq plugins using a comprehensive JavaScript SDK that provides APIs for plugin lifecycle management, UI injection, and event handling to assist in rapid prototyping and debugging.

What is the best way to register a custom slash command in Logseq?

Registering a custom slash command in Logseq is achieved by using the SDK's integrated APIs and example workflows, which provide the necessary structure to quickly implement and test custom editor commands.

Does the Logseq SDK support UI injection and property schema definition?

Yes, the Logseq SDK supports extending functionality by allowing you to register UI components, property schemas, and queries efficiently to build structured plugin features.

Can I use webpack and parcel for Logseq plugin development?

Yes, Logseq plugin development workflows are compatible with build tools like webpack and parcel, alongside pnpm for package management, enabling structured and secure project bundling.

How does the Logseq SDK handle data querying and event handling?

The Logseq SDK manages data querying and event handling by providing structured API references that cover plugin lifecycle management, allowing plugins to securely interact with and query data.