Skip to content

Template to quickly start working on a new Inkdrop plugin

License

Notifications You must be signed in to change notification settings

jmerle/inkdrop-plugin-template

Repository files navigation

Inkdrop Plugin Template

This template repository provides an easy way to start working on a new Inkdrop plugin with all batteries included.

See Auto Reload for a plugin based on this template.

Getting Started

  1. Create a new repository by clicking the "Use this template" button. It is recommended to name the repository inkdrop-hello-world for a plugin called hello-world.
  2. Edit the README.md, LICENSE and package.json files and make sure the data inside them is correct and using your username and repository name.
  3. Remove everything from the next horizontal line and above from this README and start reading the Contributing Guide to learn how to set-up a development environment and how to publish new releases.

Hello World plugin for Inkdrop

Build Status Latest Release Downloads

Short description about the plugin.

Install

ipm install hello-world

Usage

Plugin usage, supported by screenshots where useful.

Changelog

See the GitHub Releases for an overview of what changed in each update.

Contributing

All contributions are welcome. Please read the Contributing Guide first as it contains information regarding the tools used by the project and instructions on how to set up a development environment.

About

Template to quickly start working on a new Inkdrop plugin

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages