website/docs/plugins/plugin/io.github.personalizedrefri.../index.html

297 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="&#x2F;plugins/favicon.png" />
<link rel="stylesheet" href="&#x2F;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="&#x2F;plugins/bundle-main.js"></script>
<script src="&#x2F;plugins/bundle-components.js"></script>
<title>Joplin Plugins - Extra Markdown viewer settings</title>
<meta property="og:title" content="Joplin Plugin: Extra Markdown viewer settings"/>
<meta property="og:description" content="Pagination, font family and size customization for Joplin&#39;s Markdown viewer. Supports mobile and desktop. (Beta)."/>
<meta property="og:image" content="https:&#x2F;&#x2F;raw.githubusercontent.com&#x2F;personalizedrefrigerator&#x2F;joplin-plugin-extra-viewer-settings&#x2F;HEAD&#x2F;images&#x2F;icon-256.png"/>
<script src="&#x2F;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="&#x2F;plugins"><i class="fas fa-home"></i> Home</a>
</li>
<li class="breadcrumb-item"><a id="current-category-nav-link" href="&#x2F;plugins/">All</a></li>
<li class="breadcrumb-item active" aria-current="page">Extra Markdown viewer settings</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:&#x2F;&#x2F;raw.githubusercontent.com&#x2F;personalizedrefrigerator&#x2F;joplin-plugin-extra-viewer-settings&#x2F;HEAD&#x2F;images&#x2F;icon-256.png"
alt="Plugin icon"
/>
<div>
<h1 class="card-title">Extra Markdown viewer settings</h1>
<div class="card-title pb-2">
by
<a
href="./?search=author%3D%22Henry Heino%22%20max-results%3D20"
style="display: inline;"
>
Henry Heino
</a>
</div>
</div>
</div>
<div class="categories">
<a class="plugin-category me-2 badge" href="&#x2F;plugins/#tab-viewer">
<i class="fas fa-tag"></i> viewer
</a>
</div>
</div>
<div class="download-link-container">
<a
href="/plugins/downloadPlugin.html?plugin=io.github.personalizedrefrigerator.note-viewer-settings"
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:&#x2F;&#x2F;raw.githubusercontent.com&#x2F;personalizedrefrigerator&#x2F;joplin-plugin-extra-viewer-settings&#x2F;HEAD&#x2F;images&#x2F;screenshot-3.png" alt="Screenshot: A single page of a note with math is rendered. A page number is shown at the bottom of the screen and the text uses a medium, serif font."/>
<img src="https:&#x2F;&#x2F;raw.githubusercontent.com&#x2F;personalizedrefrigerator&#x2F;joplin-plugin-extra-viewer-settings&#x2F;HEAD&#x2F;images&#x2F;screenshot-2.png" alt="Screenshot: Shows a settings dialog above the editor including font size and pagination settings"/>
<img src="https:&#x2F;&#x2F;raw.githubusercontent.com&#x2F;personalizedrefrigerator&#x2F;joplin-plugin-extra-viewer-settings&#x2F;HEAD&#x2F;images&#x2F;screenshot.png" alt="Screenshot: Shows a paginated copy of Joplin&#39;s welcome notes. Arrows are available to switch pages"/>
</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">Pagination, font family and size customization for Joplin&#39;s Markdown viewer. Supports mobile and desktop. (Beta).</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:&#x2F;&#x2F;github.com&#x2F;personalizedrefrigerator&#x2F;joplin-plugin-extra-viewer-settings&#x2F; style="display: block;"><i class="fa-solid fa-link"></i> Repository</a></li>
<li><a href=https:&#x2F;&#x2F;github.com&#x2F;personalizedrefrigerator&#x2F;joplin-plugin-extra-viewer-settings&#x2F; style="display: block;"><i class="fa-solid fa-link"></i> Homepage</a></li>
<li>
<a
id="view-plugin-source-link"
href="&#x2F;plugins/view-source.html?plugin=io.github.personalizedrefrigerator.note-viewer-settings"
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%22personalizedrefrigerator%22%20max-results%3D20" class="maintainer-link">
personalizedrefrigerator
</a>
</td>
</tr>
<tr><th>Version:</th><td>0.4.0</td></tr>
<tr><th>Minimum app version:</th><td>3.0</td></tr>
<tr><th>Downloads: This version:</th><td>359</td></tr>
<tr><th>Last updated:</th><td class="process--format-as-local-time">2024-09-20T21:09:25Z</td></tr>
</tbody>
</table>
</div>
<div class="container section" id="readme" data--is-rendered-markdown>
<h1>Extra Markdown viewer settings</h1>
<p>This plugin provides several new settings for <a href="https://joplinapp.org/">Joplin</a>'s Markdown viewer.</p>
<h2>Screenshot</h2>
<center>
<img src="https://raw.githubusercontent.com/personalizedrefrigerator/joplin-plugin-extra-viewer-settings/HEAD/images/screenshot-3.png" alt="Screenshot: A single page of a note with math is rendered. A page number is shown at the bottom of the screen and the text uses a medium, serif font." />
<p>This screenshot shows a note in paginated mode. Extra markdown viewer settings provides buttons for navigating between pages and a jump to page input at the bottom of the screen. Paginated mode can be enabled or disabled using the gear icon at the top right of the screen.</p>
</center>
<h2>Platform support</h2>
<p>This plugin supports both Joplin mobile and desktop. On mobile, it may be necessary to restart Joplin after installng the plugin for settings to be correctly applied.</p>
<h2>Summary of available settings</h2>
<ul>
<li><strong>Paginate</strong>: Breaks notes into pages, saves and restores the last open page.
<ul>
<li><strong>Default value</strong>: Enabled on mobile, disabled on desktop.</li>
<li><strong>Known issue(s)</strong>:
<ul>
<li><strong>Desktop</strong>: When enabled, the note viewer's scroll position does not sync with the note editor.</li>
<li><strong>Desktop and mobile</strong>: Rapidly changing viewer settings or window size may cause the reading location to be lost.</li>
</ul>
</li>
</ul>
</li>
<li><strong>Viewer font family</strong>: Sets the font family for just the Markdown viewer.</li>
<li><strong>Viewer font size</strong>: Sets the font size for just the Markdown viewer. If zero, the default font size will be used.</li>
<li><strong>Viewer maximum width</strong>: Sets the maximum content width in the Markdown viewer.</li>
</ul>
<h2>Changing settings</h2>
<p>Most settings can be changed by clicking on the gear icon at the top right of Joplin's Markdown viewer:</p>
<p><img src="https://github.com/user-attachments/assets/6ab058de-67a9-40cb-92eb-a2de551572a2" alt="screenshot: Gear highlighted at top right of Joplin's Markdown viewer" /></p>
<p>This opens a settings dialog:</p>
<p><img src="https://github.com/user-attachments/assets/be302fed-15b7-4c6d-b29c-f7432a274e01" alt="screenshot: Settings dialog with text size, maximum width, and paginate" /></p>
<p>Other settings can only be changed from Joplin's configuration screen.</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="&#x2F;plugins/terms-and-conditions.html">Terms and conditions</a>
<a class="link privacy" href="&#x2F;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>