Awesome

Logseq Plugin Samples

This repository contains sample code illustrating the Logseq Plugin API. You can read, play with or adapt from these samples to create your own plugins.

Plugin APIs: https://plugins-doc.logseq.com

Prerequisites

You need to have node and npm(or yarn) installed on your system to run the examples. Then install the latest Logseq Desktop App from here.

Using `nvm` to install `node` and `npm`

For those who are not familiar with the installation of Node.js and NPM, a simple solution would be to install Node Version Manager (NVM)(link). The installation is straightforward: just download and run the installation bash script. You may need to give access permissions to the script.

After installing nvm, using the command nvm install 22(for current) or nvm install 20(for LTS), you'll be able to install the current version of node and npm on your machine. Because nvm installs locally, there is no need for the sudo command.

For those familiar, nvm acts similarly to anaconda: the same way you can select your version of python with anaconda, you can choose your version of node.js.

Usage

git clone https://github.com/logseq/logseq-plugin-samples
open Logseq Desktop client and turn on Developer mode in user settings panel
open the toolbar dot menus and navigate to plugins page
read the README file of the sample you want to load, then determine if it should be rebuilt (npm install && npm run build)
navigate to the plugins dashboard: <kbd>t</kbd><kbd>p</kbd>
click Load unpacked plugin button, then select the sample directory to load it

⚠️ To avoid loading plugin failures occasionally and for performance reasons, it is recommended to keep the plugin SDK @logseq/libs as up-to-date as possible.

Getting Started

License

MIT