Giter VIP home page Giter VIP logo

marketplace's Introduction

Marketplace packages

A packages manager for Logseq marketplace plugins.

How to write a plugin for Logseq?

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

Plugins API: https://logseq.github.io/plugins/.

Ensure that your plugin has a publish.yml file, so when you create a release from a tag, it will do the build dance and make you a zip file. Then make a tag (something like v0.0.1), and create a release from it. Ensure the following are true before submitting your plugin:

  • The release has a zip file attached in addition to the "Source code (zip)" link. (It might take a minute for build system to create the zip after creating the release.)
  • It's clear from your README what the plugin does, and how to use it.
  • It has at least one image or gif showing it in action.

How to submit your plugin?

  1. Fork this repo to your Github account.
  2. Create a package directory under ./packages root based on your plugin name.
  3. Write a manifest.json file to the package root. Valid fields as follows:
    • title- A title for plugin list item display.
    • description- A short description about your plugin.
    • author- The author's name.
    • repo- The GitHub repository identifier, like {user}/{repo}.
    • icon- [optional] A logo for better recognition. default: ""
    • theme- [optional] A theme plugin? default: false
    • sponsors - [optional] Sponsor external links. default: []
  4. Make a Github Pull Request :)

marketplace's People

Contributors

benjaffe avatar benjypng avatar briansunter avatar cannibalox avatar debanjandhar12 avatar dmytrodubinin avatar haydenull avatar hyrijk avatar kerfufflev2 avatar l3ony2k avatar mendax1234 avatar pengx17 avatar qwxlea avatar rcvd avatar renatocaliari avatar santiyounger avatar sawhney17 avatar scottrblock avatar sethfair avatar sethyuan avatar sidharth-panwar avatar sywhb avatar tankcool avatar ttytm avatar vipzhicheng avatar vyleung avatar xxchan avatar xyhp915 avatar yoyurec avatar zyrohex avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.