mirror of https://github.com/joplin/website.git
319 lines
12 KiB
HTML
319 lines
12 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 - Outline</title>
|
|
|
|
<meta property="og:title" content="Joplin Plugin: Outline"/>
|
|
<meta property="og:description" content="Outline (TOC) sidebar plugin for joplin."/>
|
|
<meta property="og:image" content=""/>
|
|
|
|
<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">Outline</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 -missing"
|
|
src=""
|
|
alt="Plugin icon"
|
|
/>
|
|
<div>
|
|
<h1 class="card-title">Outline</h1>
|
|
<div class="card-title pb-2">
|
|
by
|
|
<a
|
|
href="./?search=author%3D%22cqroot%22%20max-results%3D20"
|
|
style="display: inline;"
|
|
>
|
|
cqroot
|
|
</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="categories">
|
|
<a class="plugin-category me-2 badge" href="/plugins/#tab-integrations">
|
|
<i class="fas fa-tag"></i> integrations
|
|
</a>
|
|
</div>
|
|
</div>
|
|
<div class="download-link-container">
|
|
<a
|
|
href="/plugins/downloadPlugin.html?plugin=outline"
|
|
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">
|
|
</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">Outline (TOC) sidebar plugin for joplin.</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/cqroot/joplin-outline 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=outline"
|
|
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%22cqroot%22%20max-results%3D20" class="maintainer-link">
|
|
cqroot
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
<tr><th>Version:</th><td>1.5.13</td></tr>
|
|
<tr><th>Minimum app version:</th><td>1.6.7</td></tr>
|
|
<tr><th>Downloads: This version:</th><td>9902</td></tr>
|
|
<tr><th>Last updated:</th><td class="process--format-as-local-time">2023-11-13T18:08:05Z</td></tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="container section" id="readme" data--is-rendered-markdown>
|
|
|
|
<div align="center">
|
|
<h1>Joplin Outline Plugin</h1>
|
|
<i>This is a outline plugin for <a href="https://github.com/laurent22/joplin">Joplin</a>. Refer to <a href="https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/toc/">joplin toc</a>.</i>
|
|
<p align="center">
|
|
<a href="https://raw.githubusercontent.com/cqroot/joplin-outline/HEAD/README.md">English</a>
|
|
·
|
|
<a href="https://raw.githubusercontent.com/cqroot/joplin-outline/HEAD/README.zh-CN.md">简体中文</a>
|
|
<br />
|
|
</p>
|
|
<p>
|
|
<a href="https://github.com/cqroot/joplin-outline/actions">
|
|
<img src="https://github.com/cqroot/joplin-outline/workflows/test/badge.svg" alt="Action Status" />
|
|
</a>
|
|
<img src="https://img.shields.io/github/issues/cqroot/joplin-outline" />
|
|
<img src="https://img.shields.io/github/license/cqroot/joplin-outline" />
|
|
<img src="https://img.shields.io/npm/v/joplin-plugin-outline?label=version" />
|
|
<img src="https://img.shields.io/github/downloads/cqroot/joplin-outline/total?label=github%20downloads" />
|
|
<img src="https://img.shields.io/npm/dt/joplin-plugin-outline?label=npm%20downloads" />
|
|
</p>
|
|
|
|
</div>
|
|
<p><img src="https://raw.githubusercontent.com/cqroot/joplin-outline/HEAD/.github/screenshot.png" alt="screenshot" /></p>
|
|
<h2>Features</h2>
|
|
<ul>
|
|
<li>Support atx-style headers (<code>#</code>), not setext-style headers (<code>---</code>, <code>===</code>).</li>
|
|
<li>Support right click to paste markdown inner link.</li>
|
|
<li>Support collapsible outline.</li>
|
|
<li>Support automatic numbering.</li>
|
|
<li>Support custom style.</li>
|
|
<li>Support adding custom symbols before headings.</li>
|
|
<li>Support jumping to header in Editor Mode. (contributed by <a href="https://github.com/jerrylususu/joplin-outline">@jerrylususu</a>)</li>
|
|
</ul>
|
|
<h2>Documentation</h2>
|
|
<ul>
|
|
<li><a href="https://github.com/cqroot/joplin-outline/wiki/Custom-panel-style">Custom panel style</a></li>
|
|
</ul>
|
|
<h2>Requirements</h2>
|
|
<ul>
|
|
<li>Joplin 1.3.15 or higher for application plugins support.</li>
|
|
</ul>
|
|
<h2>Installation</h2>
|
|
<p>To install joplin-outline, copy <a href="https://github.com/cqroot/joplin-outline/releases/latest">outline.jpl</a> to your profile's <code>plugins</code> directory. The outline will be automatically loaded and executed when you restart the application.</p>
|
|
<h2>Building</h2>
|
|
<h3>Building the plugin</h3>
|
|
<p>The plugin is built using Webpack, which creates the compiled code 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>
|
|
<h3>Updating the plugin framework</h3>
|
|
<p>To update the plugin framework, run <code>yo joplin --update</code></p>
|
|
<p>Keep in mind that doing so will overwrite all the framework-related files <strong>outside of the "src/" directory</strong> (your source code will not be touched). So if you have modified any of the framework-related files, such as package.json or .gitignore, make sure your code is under version control so that you can check the diff and re-apply your changes.</p>
|
|
<p>For that reason, it's generally best not to change any of the framework files or to do so in a way that minimises the number of changes. For example, if you want to modify the Webpack config, create a new separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.</p>
|
|
<h2>Community</h2>
|
|
<p><a href="https://discourse.joplinapp.org/t/a-markdown-outline-sidebar-plugin-for-joplin/13364">A markdown outline sidebar plugin for Joplin</a></p>
|
|
<p><a href="https://discourse.joplinapp.org/t/toc-as-the-sidebar/5979/64">Toc as the sidebar</a></p>
|
|
<h2>Contributors</h2>
|
|
<a href="https://github.com/cqroot/joplin-outline/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=cqroot/joplin-outline" />
|
|
</a>
|
|
|
|
</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>
|
|
|