mirror of https://github.com/joplin/website.git
308 lines
13 KiB
HTML
308 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
|
|
<head>
|
|
<!-- Common page configuration that goes in the <head></head> tag -->
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1.0,minimum-scale=1.0,viewport-fit=cover"/>
|
|
<meta http-equiv="Content-Security-Policy" content="default-src 'self'; img-src * data: ; style-src 'self' 'unsafe-inline' ; child-src 'none' ; connect-src 'self' raw.githubusercontent.com ;"/>
|
|
<link rel="icon" type="image/x-icon" href="/plugins/favicon.png" />
|
|
<link rel="stylesheet" href="/plugins/fontawesome-6.4.2/css/all.min.css" type="text/css"/>
|
|
|
|
<!-- Allow included JavaScipt files to determine the root directory of this site. -->
|
|
<script id="site-root" type="text/plain">/plugins</script>
|
|
|
|
<!-- Scripts used by all pages -->
|
|
<script src="/plugins/bundle-main.js"></script>
|
|
<script src="/plugins/bundle-components.js"></script>
|
|
<title>Joplin Plugins - Remote-Note-Pull</title>
|
|
|
|
<meta property="og:title" content="Joplin Plugin: Remote-Note-Pull"/>
|
|
<meta property="og:description" content="This plugin will periodically pull public available markdown documents into your notebook and keeps them up to date"/>
|
|
<meta property="og:image" content="https://raw.githubusercontent.com/hegerdes/joplin-plugin-remote-note-pull/HEAD/docs/images/256-hegerdes.png"/>
|
|
|
|
<script src="/plugins/bundle-pluginPage.js"></script>
|
|
</head>
|
|
|
|
<body>
|
|
<nav class="navbar navbar-expand-lg bg-body-tertiary sticky-top">
|
|
<div class="container">
|
|
<a class="navbar-brand" href="https://joplinapp.org/">
|
|
<img src="/plugins/joplin-logo.png" alt="Home"/>
|
|
</a>
|
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
|
|
<span class="navbar-toggler-icon"></span>
|
|
</button>
|
|
<div class="collapse navbar-collapse" id="navbarSupportedContent">
|
|
<ul class="navbar-nav ms-auto me-2 mb-2 mb-lg-0">
|
|
<li class="nav-item">
|
|
<a class="nav-link active" aria-current="page" href="/plugins">Plugins</a>
|
|
</li>
|
|
<li class="nav-item">
|
|
<a class="nav-link" href="https://joplinapp.org/news/">News</a>
|
|
</li>
|
|
<li class="nav-item">
|
|
<a class="nav-link" href="https://joplinapp.org/help/">Help</a>
|
|
</li>
|
|
<li class="nav-item">
|
|
<a class="nav-link" href="https://discourse.joplinapp.org/">Forum</a>
|
|
</li>
|
|
</ul>
|
|
<div class="search-field col-12 col-lg-3 mb-3 mb-lg-0 me-lg-3">
|
|
<i class="fa-solid fa-magnifying-glass search-icon" alt=""></i>
|
|
<input
|
|
type="search"
|
|
class="form-control search-input"
|
|
placeholder="Search..."
|
|
id="search-input"/>
|
|
<div class="search-results" id="search-results-container" aria-live="polite"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<main class="plugin-details">
|
|
<nav aria-label="breadcrumb" class="container breadcrumb-container">
|
|
<ol class="breadcrumb">
|
|
<li class="breadcrumb-item">
|
|
<a href="/plugins"><i class="fas fa-home"></i> Home</a>
|
|
</li>
|
|
<li class="breadcrumb-item"><a id="current-category-nav-link" href="/plugins/">All</a></li>
|
|
<li class="breadcrumb-item active" aria-current="page">Remote-Note-Pull</li>
|
|
</ol>
|
|
</nav>
|
|
<div class="plugin-overview">
|
|
<div class="spacer">
|
|
</div>
|
|
<div class="plugin-page-header">
|
|
<div class="title plugin-page-title">
|
|
<img
|
|
class="icon plugin-icon -dark-mode-shadow"
|
|
src="https://raw.githubusercontent.com/hegerdes/joplin-plugin-remote-note-pull/HEAD/docs/images/256-hegerdes.png"
|
|
alt="Plugin icon"
|
|
/>
|
|
<div>
|
|
<h1 class="card-title">Remote-Note-Pull</h1>
|
|
<div class="card-title pb-2">
|
|
by
|
|
<a
|
|
href="./?search=author%3D%22hegerdes%22%20max-results%3D20"
|
|
style="display: inline;"
|
|
>
|
|
hegerdes
|
|
</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="categories">
|
|
<a class="plugin-category me-2 badge" href="/plugins/#tab-personal knowledge management">
|
|
<i class="fas fa-tag"></i> personal knowledge management
|
|
</a>
|
|
<a class="plugin-category me-2 badge" href="/plugins/#tab-productivity">
|
|
<i class="fas fa-tag"></i> productivity
|
|
</a>
|
|
</div>
|
|
</div>
|
|
<div class="download-link-container">
|
|
<a
|
|
href="/plugins/downloadPlugin.html?plugin=github.hegerdes.joplin_remote_note_pull"
|
|
class="btn btn-primary process--append-parent-tab-to-href"
|
|
>
|
|
Install Plugin
|
|
</a>
|
|
</div>
|
|
</div>
|
|
<div class="plugin-content">
|
|
<div class="secondary-section">
|
|
<div class="content" id="screenshots-container">
|
|
<div id="raw-screenshots">
|
|
<img src="https://raw.githubusercontent.com/hegerdes/joplin-plugin-remote-note-pull/HEAD/docs/images/thumpnail.png" alt="Unlabeled screenshot"/>
|
|
<img src="https://raw.githubusercontent.com/hegerdes/joplin-plugin-remote-note-pull/HEAD/docs/images/new_note_dialog.png" alt="Unlabeled screenshot"/>
|
|
<img src="https://raw.githubusercontent.com/hegerdes/joplin-plugin-remote-note-pull/HEAD/docs/images/settings.png" alt="Unlabeled screenshot"/>
|
|
</div>
|
|
|
|
<!-- See https://getbootstrap.com/docs/5.3/components/carousel/ -->
|
|
<div id="screenshots-carousel" class="carousel slide">
|
|
<button
|
|
class="carousel-control-prev"
|
|
type="button"
|
|
data-bs-target="#screenshots-carousel"
|
|
data-bs-slide="prev"
|
|
>
|
|
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
|
|
<span class="visually-hidden">Previous</span>
|
|
</button>
|
|
<button
|
|
class="carousel-control-next"
|
|
type="button"
|
|
data-bs-target="#screenshots-carousel"
|
|
data-bs-slide="next"
|
|
>
|
|
<span class="carousel-control-next-icon" aria-hidden="true"></span>
|
|
<span class="visually-hidden">Next</span>
|
|
</button>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="container section">
|
|
<h3>Description</h3>
|
|
<p class="card-text pb-4">This plugin will periodically pull public available markdown documents into your notebook and keeps them up to date</p>
|
|
</div>
|
|
<div class="container section">
|
|
<h3>Additional Information</h3>
|
|
<table class="additional-information-table">
|
|
<tbody>
|
|
<tr>
|
|
<th>Links:</th>
|
|
<td>
|
|
<ul class="list-group list-group-flush text-break">
|
|
<li><a href=https://github.com/hegerdes/joplin-plugin-remote-note-pull style="display: block;"><i class="fa-solid fa-link"></i> Repository</a></li>
|
|
<li><a href=https://github.com/hegerdes/joplin-plugin-remote-note-pull style="display: block;"><i class="fa-solid fa-link"></i> Homepage</a></li>
|
|
<li>
|
|
<a
|
|
id="view-plugin-source-link"
|
|
href="/plugins/view-source.html?plugin=github.hegerdes.joplin_remote_note_pull"
|
|
class="process--append-parent-tab-to-href"
|
|
>
|
|
<i class="fa-solid fa-code"></i> View source
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Maintainers:</th>
|
|
<td>
|
|
<a href="./?search=maintainer%3D%22hegerdes%22%20max-results%3D20" class="maintainer-link">
|
|
hegerdes
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
<tr><th>Version:</th><td>1.3.0</td></tr>
|
|
<tr><th>Minimum app version:</th><td>2.8</td></tr>
|
|
<tr><th>Downloads: This version:</th><td>100</td></tr>
|
|
<tr><th>Last updated:</th><td class="process--format-as-local-time">2024-08-08T16:08:49Z</td></tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="container section" id="readme" data--is-rendered-markdown>
|
|
|
|
<h1>Joplin Plugin Remote Note Pull</h1>
|
|
<p><a href="https://github.com/hegerdes/joplin-plugin-remote-note-pull/actions/workflows/test-compile.yml"><img src="https://github.com/hegerdes/joplin-plugin-remote-note-pull/actions/workflows/test-compile.yml/badge.svg" alt="Plugin Test Build" /></a> <a href="https://GitHub.com/hegerdes/joplin-plugin-remote-note-pull/issues/"><img src="https://img.shields.io/github/issues/hegerdes/joplin-plugin-remote-note-pull.svg" alt="GitHub issues" /></a> <a href="https://GitHub.com/hegerdes/joplin-plugin-remote-note-pull/releases/"><img src="https://img.shields.io/github/release/hegerdes/joplin-plugin-remote-note-pull.svg" alt="GitHub release" /></a></p>
|
|
<p>This plugin allows websites to be saved as notes and updated periodically based on the original website URL.</p>
|
|
<p>This way you can always work with the latest version of online cheat sheets/websites and docs in your favourite notebook without manually update it by yourself.</p>
|
|
<h2>Install</h2>
|
|
<p><strong>Official:</strong>
|
|
Joplin has a <a href="https://joplinapp.org/plugins/plugin/github.hegerdes.joplin_remote_note_pull/">community plugin store</a> with an integrated browser for plugin. This plugin is now also released there. Just search for <code>remote-note-pull</code>.</p>
|
|
<p><strong>Manual:</strong>
|
|
You can get the latest version like this:</p>
|
|
<ul>
|
|
<li>Download the latest release from <a href="https://github.com/hegerdes/joplin-plugin-remote-note-pull/releases">GitHub Releases</a> or <a href="https://www.npmjs.com/package/joplin-plugin-remote-note-pull">NpmJs</a></li>
|
|
<li>Extract the archive</li>
|
|
<li>Open Joplin and open the Settings via the Tools/Options menu</li>
|
|
<li>Go to Plugins</li>
|
|
<li>Click <em>Manage Plugins</em> and browse to the downloaded release and chose the <code>.jpl</code> file</li>
|
|
</ul>
|
|
<h2>Getting Started</h2>
|
|
<p>After Install you can go to the <em>Tools</em> menu. There will be a new option <em>Create new SyncNote</em>.</p>
|
|
<p>Enter a URL and wait some second. The newly created note will be periodically updated with the URL you entered. The default interval is 30m.
|
|
<strong>NOTE:</strong> Every manual change in the note will be overwritten!</p>
|
|
<p><img src="https://raw.githubusercontent.com/hegerdes/joplin-plugin-remote-note-pull/HEAD/docs/images/new_note_dialog.png" alt="New Note Option Dialog" /></p>
|
|
<p>You can change the default interval via the Joplin settings. A new option group will be added on plugin install. It allows you to enable the sync feature, sets the sync interval and the default target notebook.
|
|
With the <em>DownArrow</em> Icon in the top right you can also trigger a manual update on any currently selected sync-note.</p>
|
|
<p><img src="https://raw.githubusercontent.com/hegerdes/joplin-plugin-remote-note-pull/HEAD/docs/images/settings.png" alt="Settings Dialog" /></p>
|
|
<h2>Contribute</h2>
|
|
<p>If you have any feature requests or found a bug feel free to open a <a href="https://github.com/hegerdes/joplin-plugin-remote-note-pull/issues/new/choose">GitHub Issue</a> or even provide a pull-request.</p>
|
|
<h2>Development</h2>
|
|
<p>Make sure you have nodeJS >= 16 installed</p>
|
|
<p>Clone the repo and open it in your favourite editor. The most important files are:</p>
|
|
<ul>
|
|
<li><code>/src/index.ts</code>, which contains the entry point for the plugin source code.</li>
|
|
<li><code>/src/manifest.json</code>, which is the plugin manifest. It contains information such as the plugin a name, version, etc.</li>
|
|
</ul>
|
|
<p>See here for information about publishing <a href="https://discourse.joplinapp.org/t/plugins-multiple-questions-sharing-publishing-etc/30551">Joplin Forum</a>
|
|
For more information see <a href="https://github.com/laurent22/joplin/tree/dev/packages/generator-joplin#publishing-the-plugin">here</a></p>
|
|
<h2>Building the plugin</h2>
|
|
<p>The plugin is built using Webpack, which creates a compiled bundle in <code>/dist</code>. A JPL archive will also be created at the root, which can use to distribute the plugin.</p>
|
|
<p>To build the plugin, simply run <code>npm run dist</code>.</p>
|
|
<p>The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.</p>
|
|
<p>You can also use <code>npm run dev</code> to build the plugin and open Joplin in dev mode.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</main>
|
|
|
|
<footer class="page-footer">
|
|
<div class="plugin-documentation-section">
|
|
<div class="heading">
|
|
Would you like to submit or develop a plugin? Consult our documentation:
|
|
</div>
|
|
<a class="btn btn-outline-primary" href="https://joplinapp.org/help/api/get_started/plugins">
|
|
See documentation
|
|
</a>
|
|
</div>
|
|
|
|
<div class="links legal-and-about-links">
|
|
<div class="copyright">© Joplin 2023 - 2024</div>
|
|
<a class="link terms-and-conditions" href="/plugins/terms-and-conditions.html">Terms and conditions</a>
|
|
<a class="link privacy" href="/plugins/privacy-policy.html">Privacy policy</a>
|
|
</div>
|
|
|
|
|
|
<div class="site-links">
|
|
<a
|
|
class="a-github"
|
|
href="https://github.com/joplin/website-plugin-discovery"
|
|
aria-label="GitHub"
|
|
title="GitHub"
|
|
>
|
|
<i class="fab fa-github"></i>
|
|
</a>
|
|
<a
|
|
class="a-discord"
|
|
href="https://discord.com/invite/VSj7AFHvpq"
|
|
aria-label="Discord"
|
|
title="Discord"
|
|
>
|
|
<i class="fab fa-discord"></i>
|
|
</a>
|
|
<a
|
|
class="a-linkedin"
|
|
href="https://www.linkedin.com/company/joplin"
|
|
aria-label="LinkedIn"
|
|
title="LinkedIn"
|
|
>
|
|
<i class="fab fa-linkedin"></i>
|
|
</a>
|
|
<a
|
|
class="a-twitter"
|
|
href="https://twitter.com/joplinapp"
|
|
aria-label="Twitter"
|
|
title="Twitter"
|
|
>
|
|
<i class="fab fa-twitter"></i>
|
|
</a>
|
|
<a
|
|
class="a-mastodon"
|
|
href="https://mastodon.social/@joplinapp"
|
|
aria-label="Mastodon"
|
|
title="Mastodon"
|
|
>
|
|
<i class="fab fa-mastodon"></i>
|
|
</a>
|
|
<a
|
|
class="a-patreon"
|
|
href="https://www.patreon.com/joplin"
|
|
aria-label="Patreon"
|
|
title="Patreon"
|
|
>
|
|
<i class="fab fa-patreon"></i>
|
|
</a>
|
|
</div>
|
|
</footer>
|
|
|
|
</body>
|
|
|
|
</html>
|
|
|