website/docs/plugins/plugin/com.andrejilderda.macOSTheme/index.html

304 lines
12 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!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 - macOS theme</title>
<meta property="og:title" content="Joplin Plugin: macOS theme"/>
<meta property="og:description" content="Native looking macOS theme for Joplin. Also works on non-macOS devices."/>
<meta property="og:image" content="https:&#x2F;&#x2F;raw.githubusercontent.com&#x2F;ajilderda&#x2F;joplin-macos-native-theme&#x2F;HEAD&#x2F;images&#x2F;icon-128.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">macOS theme</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;ajilderda&#x2F;joplin-macos-native-theme&#x2F;HEAD&#x2F;images&#x2F;icon-128.png"
alt="Plugin icon"
/>
<div>
<h1 class="card-title">macOS theme</h1>
<div class="card-title pb-2">
by
<a
href="./?search=author%3D%22Andre Jilderda%22%20max-results%3D20"
style="display: inline;"
>
Andre Jilderda
</a>
</div>
</div>
</div>
<div class="categories">
<a class="plugin-category me-2 badge" href="&#x2F;plugins/#tab-themes">
<i class="fas fa-tag"></i> themes
</a>
</div>
</div>
<div class="download-link-container">
<a
href="/plugins/downloadPlugin.html?plugin=com.andrejilderda.macOSTheme"
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;ajilderda&#x2F;joplin-macos-native-theme&#x2F;HEAD&#x2F;images&#x2F;macos-theme-for-joplin.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">Native looking macOS theme for Joplin. Also works on non-macOS devices.</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;ajilderda&#x2F;joplin-macos-native-theme style="display: block;"><i class="fa-solid fa-link"></i> Repository</a></li>
<li><a href=https:&#x2F;&#x2F;github.com&#x2F;ajilderda&#x2F;joplin-macos-native-theme 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=com.andrejilderda.macOSTheme"
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%22andrejilderda%22%20max-results%3D20" class="maintainer-link">
andrejilderda
</a>
</td>
</tr>
<tr><th>Version:</th><td>1.5.8</td></tr>
<tr><th>Minimum app version:</th><td>2.2.4</td></tr>
<tr><th>Downloads: This version:</th><td>4756</td></tr>
<tr><th>Last updated:</th><td class="process--format-as-local-time">2024-08-20T20:42:29Z</td></tr>
</tbody>
</table>
</div>
<div class="container section" id="readme" data--is-rendered-markdown>
<h1>macOS theme for Joplin</h1>
<p>Native looking macOS theme for note taking app <a href="https://joplinapp.org/">Joplin</a> v2.2.4 and above. Also works on non-macOS devices.</p>
<p><img src="https://raw.githubusercontent.com/ajilderda/joplin-macos-native-theme/HEAD//images/macos-theme-for-joplin.png" alt="macOS theme for Joplin" /></p>
<ul>
<li>✨ Completely styled UI, including all controls,</li>
<li>🌜 Choose between light, dark, light with dark sidebar or auto (light/dark based on system preferences),</li>
<li>👌 Use native icons (macOS only) or Phosphor icon family,</li>
<li>👨‍🎨 Easy to customise via Joplin preferences.</li>
</ul>
<h2>Installation</h2>
<ul>
<li>Open Joplin preferences 'Plugins', search for 'macOS theme' and install the theme.</li>
<li>Restart Joplin. Enjoy!</li>
</ul>
<p>Make sure you set Appearance Theme to either Light or Dark. If you experience a flash when switching notebooks sync the Light/Dark-settings under Appearance Theme with the value selected under macOS theme Appearance. For more customisation options see below.</p>
<h2>Customisation</h2>
<p>After installing you can find an extra item named 'macOS theme' in Joplin's preferences. You need to restart Joplin for the changes to apply.</p>
<p><strong>Mac users</strong>: If you want to use the native icons, download and install SF Pro from the <a href="https://developer.apple.com/fonts/">Apple website here</a>.</p>
<h2>No icons?</h2>
<p>If you have the 'Icon family'-setting set to 'macOS native (SF Pro)' you need to have SF Pro installed from the <a href="https://developer.apple.com/fonts/">Apple website</a>. Note that this only works on macOS-devices.</p>
<h2>Disclaimer</h2>
<p>⚠️ Joplin uses styled-components for styling, which makes it incredibly hard to theme the app. A lot of hacky CSS workarounds and <code>!important</code>s were used. These may cause UI issues with future Joplin releases. Since it's just CSS, your data remains safe and you can easily revert the styles.</p>
<p>Feel free to <a href="https://github.com/ajilderda/joplin-macos-native-theme/issues">create an issue</a> or post a message <a href="https://discourse.joplinapp.org/t/plugin-macos-theme-for-joplin">on the forum</a> if you run into issues.</p>
<h2>Development</h2>
<p>You can tweak the theme via Joplin's preferences. If you want to go all out follow the following steps to make your own build.</p>
<p>Install dependencies:</p>
<pre class="hljs"><code>npm install
</code></pre>
<p>To build the plugin:</p>
<pre class="hljs"><code>npm run dist
</code></pre>
<p>To update the plugin framework:</p>
<pre class="hljs"><code>npm run update
</code></pre>
<p>To build just the CSS and watch for changes:</p>
<pre class="hljs"><code>npm run dev
</code></pre>
<p>The generated CSS will be available at: <a href="http://localhost:8080/macos-theme-for-joplin.css">http://localhost:8080/macos-theme-for-joplin.css</a>.</p>
<blockquote>
<p>You may want to refresh the CSS when Joplin gets focus. To do so toggle Joplin's devtools and paste <a href="https://gist.github.com/andrejilderda/f6673f1b1a986b2dc0cd01607acbff26">this script</a> in the console.</p>
</blockquote>
</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>