mirror of
https://github.com/laurent22/joplin.git
synced 2026-02-10 00:59:16 -06:00
437 lines
14 KiB
HTML
437 lines
14 KiB
HTML
<!doctype html>
|
||
<html>
|
||
|
||
<!--
|
||
|
||
!!! WARNING !!!
|
||
|
||
This file was auto-generated from readme/api/get_started/plugins.md and any manual change
|
||
made to it will be overwritten. To make a change to this file please modify
|
||
the source Markdown file:
|
||
|
||
https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.md
|
||
|
||
-->
|
||
|
||
<head>
|
||
<title>Getting started with plugin development | Joplin</title>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<link rel="stylesheet" href="https://joplinapp.org/css/bootstrap.min.css">
|
||
<link rel="shortcut icon" type="image/x-icon" href="https://joplinapp.org/favicon.ico">
|
||
<!-- <link rel="stylesheet" href="https://joplinapp.org/css/fontawesome-all.min.css"> -->
|
||
<link rel="stylesheet" href="https://joplinapp.org/css/fork-awesome.min.css">
|
||
<script src="https://joplinapp.org/js/jquery-3.2.1.slim.min.js"></script>
|
||
<style>
|
||
body {
|
||
background-color: #F1F1F1;
|
||
color: #333333;
|
||
}
|
||
table {
|
||
margin-bottom: 1em;
|
||
}
|
||
td, th {
|
||
padding: .8em;
|
||
border: 1px solid #ccc;
|
||
}
|
||
|
||
.page-markdown table pre,
|
||
.page-markdown table blockquote {
|
||
margin-bottom: 0;
|
||
}
|
||
|
||
.page-markdown table pre,
|
||
.page-markdown table blockquote {
|
||
margin-bottom: 0;
|
||
}
|
||
|
||
.page-markdown table pre {
|
||
background-color: rgba(0,0,0,0);
|
||
border: none;
|
||
margin: 0;
|
||
padding: 0;
|
||
}
|
||
|
||
h1, h2 {
|
||
border-bottom: 1px solid #eaecef;
|
||
padding-bottom: 0.3em;
|
||
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
|
||
font-weight: 600;
|
||
font-size: 2em;
|
||
margin-bottom: 16px;
|
||
}
|
||
h2 {
|
||
font-size: 1.6em;
|
||
}
|
||
h3 {
|
||
font-size: 1.3em;
|
||
}
|
||
code {
|
||
color: black;
|
||
background-color: #eee;
|
||
border: 1px solid #ccc;
|
||
font-size: .85em;
|
||
}
|
||
pre code {
|
||
border: none;
|
||
}
|
||
pre {
|
||
font-size: .85em;
|
||
}
|
||
blockquote {
|
||
font-size: 1em;
|
||
color: #555;
|
||
};
|
||
#toc ul {
|
||
margin-bottom: 10px;
|
||
}
|
||
#toc > ul > li {
|
||
margin-bottom: 10px;
|
||
}
|
||
#toc {
|
||
padding-bottom: 1em;
|
||
}
|
||
.title {
|
||
display: flex;
|
||
align-items: center;
|
||
}
|
||
.title-icon {
|
||
display: flex;
|
||
height: 1em;
|
||
}
|
||
.title-text {
|
||
display: flex;
|
||
font-weight: normal;
|
||
margin-bottom: .2em;
|
||
margin-left: .5em;
|
||
}
|
||
.sub-title {
|
||
font-weight: normal;
|
||
}
|
||
.container {
|
||
background-color: white;
|
||
padding: 0;
|
||
box-shadow: 0 10px 20px #888888;
|
||
}
|
||
table.screenshots {
|
||
margin-top: 2em;
|
||
margin-bottom: 2em;
|
||
}
|
||
table.screenshots th {
|
||
height: 3em;
|
||
text-align: center;
|
||
}
|
||
table.screenshots th,
|
||
table.screenshots td {
|
||
border: 1px solid #C2C2C2;
|
||
}
|
||
img[align="left"] {
|
||
margin-right: 10px;
|
||
margin-bottom: 10px;
|
||
}
|
||
.mobile-screenshot {
|
||
height: 40em;
|
||
padding: 1em;
|
||
}
|
||
.cli-screenshot-wrapper {
|
||
background-color: black;
|
||
vertical-align: top;
|
||
padding: 1em 2em 1em 1em;
|
||
}
|
||
.cli-screenshot {
|
||
font-family: "Monaco", "Inconsolata", "CONSOLAS", "Deja Vu Sans Mono", "Droid Sans Mono", "Andale Mono", monospace;
|
||
background-color: black;
|
||
color: white;
|
||
border: none;
|
||
}
|
||
.cli-screenshot .prompt {
|
||
color: #48C2F0;
|
||
}
|
||
.top-screenshot {
|
||
margin-top: 2em;
|
||
text-align: center;
|
||
}
|
||
.header {
|
||
position: relative;
|
||
padding-left: 2em;
|
||
padding-right: 2em;
|
||
padding-top: 1em;
|
||
padding-bottom: 1em;
|
||
color: white;
|
||
background-color: #2B2B3D;
|
||
}
|
||
.header a h1 {
|
||
color: white;
|
||
}
|
||
.header a:hover {
|
||
text-decoration: none;
|
||
}
|
||
.content {
|
||
padding-left: 2em;
|
||
padding-right: 2em;
|
||
padding-bottom: 2em;
|
||
padding-top: 2em;
|
||
}
|
||
.forkme {
|
||
position: absolute;
|
||
right: 0;
|
||
top:0;
|
||
}
|
||
.nav-wrapper {
|
||
position: relative;
|
||
width: inherit;
|
||
}
|
||
.nav {
|
||
background-color: black;
|
||
display: table;
|
||
width: inherit;
|
||
}
|
||
.nav.sticky {
|
||
position:fixed;
|
||
top: 0;
|
||
width: inherit;
|
||
box-shadow: 0 0 10px #000000;
|
||
}
|
||
.nav a {
|
||
color: white;
|
||
display: inline-block;
|
||
padding: .6em .9em .6em .9em;
|
||
}
|
||
.nav ul {
|
||
padding-left: 2em;
|
||
margin-bottom: 0;
|
||
display: table-cell;
|
||
/* min-width: 250px; */
|
||
/* For GSoC: */
|
||
min-width: 470px;
|
||
}
|
||
.nav ul li {
|
||
display: inline-block;
|
||
padding: 0;
|
||
}
|
||
.nav li.selected {
|
||
background-color: #222;
|
||
font-weight: bold;
|
||
}
|
||
.nav-right {
|
||
display: table-cell;
|
||
width: 100%;
|
||
text-align: right;
|
||
vertical-align: middle;
|
||
line-height: 0;
|
||
}
|
||
.nav-right .share-btn {
|
||
display: none;
|
||
}
|
||
.nav-right .small-share-btn {
|
||
display: none;
|
||
}
|
||
.footer {
|
||
padding-top: 1em;
|
||
border-top: 1px solid #d4d4d4;
|
||
margin-top: 2em;
|
||
color: gray;
|
||
font-size: .9em;
|
||
}
|
||
a.heading-anchor {
|
||
display: inline-block;
|
||
opacity: 0;
|
||
width: 1.3em;
|
||
font-size: 0.7em;
|
||
margin-left: 0.4em;
|
||
line-height: 1em;
|
||
text-decoration: none;
|
||
transition: opacity 0.3s;
|
||
}
|
||
a.heading-anchor:hover,
|
||
h1:hover a.heading-anchor,
|
||
h2:hover a.heading-anchor,
|
||
h3:hover a.heading-anchor,
|
||
h4:hover a.heading-anchor,
|
||
h5:hover a.heading-anchor,
|
||
h6:hover a.heading-anchor {
|
||
opacity: 1;
|
||
}
|
||
|
||
.bottom-links {
|
||
display: flex;
|
||
justify-content: center;
|
||
border-top: 1px solid #d4d4d4;
|
||
margin-top: 30px;
|
||
padding-top: 25px;
|
||
}
|
||
|
||
@media all and (min-width: 400px) {
|
||
.nav-right .share-btn {
|
||
display: inline-block;
|
||
}
|
||
.nav-right .small-share-btn {
|
||
display: none;
|
||
}
|
||
}
|
||
</style>
|
||
</head>
|
||
|
||
<body>
|
||
|
||
<div class="container page-plugins">
|
||
|
||
<div class="header">
|
||
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="https://joplinapp.org/images/ForkMe.png"/></a>
|
||
<a href="https://joplinapp.org"><h1 class="title"><img class="title-icon" src="https://joplinapp.org/images/Icon512.png"><span class="title-text">Joplin</span></h1></a>
|
||
<p class="sub-title">An open source note taking and to-do application with synchronisation capabilities</p>
|
||
</div>
|
||
|
||
<div class="nav-wrapper">
|
||
<div class="nav">
|
||
<ul>
|
||
<li class=""><a href="https://joplinapp.org/" title="Home"><i class="fa fa-home"></i></a></li>
|
||
<li><a href="https://discourse.joplinapp.org" title="Forum">Forum</a></li>
|
||
<li><a class="help" href="#" title="Menu">Menu</a></li>
|
||
<!-- <li><a class="gsod" href="https://joplinapp.org/gsod2020/" title="Google Season of Docs 2020">GSoD 2020</a></li> -->
|
||
</ul>
|
||
<div class="nav-right">
|
||
<!--
|
||
<iframe class="share-btn" src="https://www.facebook.com/plugins/share_button.php?href=http%3A%2F%2Fjoplinapp.org&layout=button&size=small&mobile_iframe=true&width=60&height=20&appId" width="60" height="20" style="border:none;overflow:hidden" scrolling="no" frameborder="0" allowTransparency="true"></iframe>
|
||
<iframe class="share-btn" src="https://platform.twitter.com/widgets/tweet_button.html?url=http%3A%2F%2Fjoplinapp.org" width="62" height="20" title="Tweet" style="border: 0; overflow: hidden;"></iframe>
|
||
-->
|
||
<iframe class="share-btn share-btn-github" src="https://ghbtns.com/github-btn.html?user=laurent22&repo=joplin&type=star&count=true" frameborder="0" scrolling="0" width="100px" height="20px"></iframe>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="content">
|
||
<div id="toc"><ul>
|
||
<li>
|
||
<p>Applications</p>
|
||
<ul>
|
||
<li><a href="https://joplinapp.org/desktop/">Desktop application</a></li>
|
||
<li><a href="https://joplinapp.org/mobile/">Mobile applications</a></li>
|
||
<li><a href="https://joplinapp.org/terminal/">Terminal application</a></li>
|
||
<li><a href="https://joplinapp.org/clipper/">Web Clipper</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Support</p>
|
||
<ul>
|
||
<li><a href="https://discourse.joplinapp.org">Joplin Forum</a></li>
|
||
<li><a href="https://joplinapp.org/markdown/">Markdown Guide</a></li>
|
||
<li><a href="https://joplinapp.org/e2ee/">How to enable end-to-end encryption</a></li>
|
||
<li><a href="https://joplinapp.org/conflict/">What is a conflict?</a></li>
|
||
<li><a href="https://joplinapp.org/debugging/">How to enable debug mode</a></li>
|
||
<li><a href="https://joplinapp.org/faq/">FAQ</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Joplin API</p>
|
||
<ul>
|
||
<li><a href="https://joplinapp.org/api/overview/">Joplin API Overview</a></li>
|
||
<li><a href="https://joplinapp.org/api/get_started/plugins/">Plugin development</a></li>
|
||
<li><a href="https://joplinapp.org/api/tutorials/toc_plugin/">Plugin tutorial</a></li>
|
||
<li><a href="https://joplinapp.org/plugin/api/classes/joplin.html">Plugin API</a></li>
|
||
<li><a href="https://joplinapp.org/api/references/rest_api/">Data API documentation</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Development</p>
|
||
<ul>
|
||
<li><a href="https://github.com/laurent22/joplin/blob/dev/BUILD.md">How to build the apps</a></li>
|
||
<li><a href="https://joplinapp.org/spec/e2ee/">End-to-end encryption spec</a></li>
|
||
<li><a href="https://joplinapp.org/spec/history/">Note History spec</a></li>
|
||
<li><a href="https://joplinapp.org/spec/sync_lock/">Sync Lock spec</a></li>
|
||
<li><a href="https://joplinapp.org/spec/plugins/">Plugin Architecture spec</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Google Summer of Code 2020</p>
|
||
<ul>
|
||
<li><a href="https://joplinapp.org/gsoc2020/index/">Google Summer of Code 2020</a></li>
|
||
<li><a href="https://joplinapp.org/gsoc2020/ideas/">Project Ideas</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>About</p>
|
||
<ul>
|
||
<li><a href="https://joplinapp.org/changelog/">Changelog (Desktop App)</a></li>
|
||
<li><a href="https://joplinapp.org/changelog_cli/">Changelog (CLI App)</a></li>
|
||
<li><a href="https://joplinapp.org/stats/">Stats</a></li>
|
||
<li><a href="https://joplinapp.org/donate/">Donate</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<h1>Getting started with plugin development<a name="getting-started-with-plugin-development" href="#getting-started-with-plugin-development" class="heading-anchor">🔗</a></h1>
|
||
<p>In this article you will learn the basic steps to build and test a plugin in Joplin.</p>
|
||
<p>## Setting up your environment</p>
|
||
<p>First you need to setup your environment:</p>
|
||
<ul>
|
||
<li>Make sure you have <a href="https://nodejs.org/">Node.js</a> and <a href="https://git-scm.com">git</a> installed.</li>
|
||
<li>Install Joplin and run it in development mode.</li>
|
||
</ul>
|
||
<p>You will also need to have Joplin installed and running in development mode, which we'll describe later.</p>
|
||
<p>But first install Yeoman and the Joplin Plugin Generator:</p>
|
||
<pre><code>npm install -g yo generator-joplin
|
||
</code></pre>
|
||
<p>Then to create the plugin, run:</p>
|
||
<pre><code>yo joplin
|
||
</code></pre>
|
||
<p>This will create the basic scafolding of the plugin. At the root of it, there is a number of configuration files which you normally won't need to change. Then the <code>src/</code> directory will contain your code. By default, the project uses TypeScript, but you are free to use plain JavaScript too - eventually the project is compiled to plain JS in any case.</p>
|
||
<p>The <code>src/</code> directory also contains a <a href="https://github.com/laurent22/joplin/blob/dev/readme/api/references/plugin_manifest/">manifest.json</a> file, which you can edit to set various information about the plugin, such as its name, homepage URL, etc.</p>
|
||
<h2>Building the plugin<a name="building-the-plugin" href="#building-the-plugin" class="heading-anchor">🔗</a></h2>
|
||
<p>The file <code>src/index.ts</code> already contain some basic code meant for testing the plugin. In particular it contains a call to <a href="https://joplinapp.org/plugin/api/classes/joplinplugins.html">joplin.plugins.register</a>, which all plugins should call to register the plugin. And an <code>onStart()</code> event handler, which will be executed by Joplin when the plugin starts.</p>
|
||
<p>To try this basic plugin, compile the app by running the following from the root of the project:</p>
|
||
<pre><code>npm run dist
|
||
</code></pre>
|
||
<p>Doing so should compile all the files into the <code>dist/</code> directory. This is from here that Joplin will load the plugin.</p>
|
||
<h2>Testing the plugin<a name="testing-the-plugin" href="#testing-the-plugin" class="heading-anchor">🔗</a></h2>
|
||
<p>In order to test the plugin, you might want to run Joplin in <a href="https://github.com/laurent22/joplin/blob/dev/readme/api/references/development_mode/">Development Mode</a>. Doing so means that Joplin will run using a different profile, so you can experiment with the plugin without risking to accidentally change or delete your data.</p>
|
||
<p>Finally, in order to test the plugin, open the Setting screen, then navigate the the <strong>Plugins</strong> section, and add the plugin path in the <strong>Development plugins</strong> text field. For example, if your plugin project path is <code>/home/user/src/joplin-plugin</code>, add this in the text field.</p>
|
||
<p>Restart the app, and Joplin should load the plugin and execute its <code>onStart</code> handler. If all went well you should see the test message in the plugin console: "Test plugin started!".</p>
|
||
<h1>Next steps<a name="next-steps" href="#next-steps" class="heading-anchor">🔗</a></h1>
|
||
<ul>
|
||
<li>You might want to check the <a href="https://github.com/laurent22/joplin/blob/dev/readme/api/tutorials/toc_plugin/">plugin tutorial</a> to get a good overview of how to create a complete plugin and how to use the plugin API.</li>
|
||
<li>For more information about the plugin API, check the <a href="https://joplinapp.org/plugin/api/classes/joplin.html">Plugin API reference</a>.</li>
|
||
</ul>
|
||
|
||
<div class="bottom-links">
|
||
<a href="https://github.com/laurent22/joplin/blob/master/readme/api/get_started/plugins.md">
|
||
<i class="fa fa-github"></i> Improve this doc
|
||
</a>
|
||
</div>
|
||
<script>
|
||
function stickyHeader() {
|
||
return; // Disabled
|
||
|
||
if ($(window).scrollTop() > 179) {
|
||
$('.nav').addClass('sticky');
|
||
} else {
|
||
$('.nav').removeClass('sticky');
|
||
}
|
||
}
|
||
|
||
$('#toc').hide();
|
||
|
||
$('.help').click(function(event) {
|
||
event.preventDefault();
|
||
$('#toc').show();
|
||
});
|
||
|
||
$(window).scroll(function() {
|
||
stickyHeader();
|
||
});
|
||
|
||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||
ga('create', 'UA-103586105-1', 'auto');
|
||
ga('send', 'pageview');
|
||
</script>
|
||
|
||
<div class="footer">
|
||
Copyright (c) 2016-2020 Laurent Cozic
|
||
</div>
|
||
</body>
|
||
</html>
|