https://github.com/benji300/joplin-wanaka-ui

Simple and clean theme for Joplin's desktop application.
https://github.com/benji300/joplin-wanaka-ui

dark-theme desktop-app joplin light-theme theme

Last synced: 3 months ago
JSON representation

Simple and clean theme for Joplin's desktop application.

• Host: GitHub
• URL: https://github.com/benji300/joplin-wanaka-ui
• Owner: benji300
• License: mit
• Created: 2020-10-29T23:09:31.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-03-28T20:13:29.000Z (almost 4 years ago)
• Last Synced: 2024-08-03T02:02:57.073Z (6 months ago)
• Topics: dark-theme, desktop-app, joplin, light-theme, theme
• Language: CSS
• Homepage:
• Size: 921 KB
• Stars: 43
• Watchers: 3
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-joplin - Wanaka UI - [UI], [Editor], [Light], [Dark]. Requires Joplin v1.4.12 or newer. (Themes)

README

        
# Joplin Wanaka UI

Joplin Wanaka UI is a theme to adapt the UI of [Joplin's](https://joplinapp.org/) desktop application.

> **Visit [Lake Wanaka](https://www.newzealand.com/int/lake-wanaka/) in New Zealand! :wink:**

> :warning: **CAUTION** - Requires Joplin **v1.6.8** or newer

## Table of contents

- [Features](#features)

  - [Screenshots](#screenshots)

- [Installation](#installation)

- [UI tweaks](#ui-tweaks)

- [Feedback](#feedback)

- [Support](#support)

- [Changes](#changes)

- [License](#license)

## Features

This theme changes the following parts of the user interface.

- Works with all built-in color themes

- Colored tags

- Cleaner note list including floating plus button to create new notes/to-dos

- Floating editor toolbar at the bottom of the editor content

  - Not supported for TinyMCE

- Local search inlined within tag list

- Improved style of panel splitters

  - Highlighted while dragging

- Changed style of synchronize area and button

- Decreased visibility of toolbar icons

  - To focus more on content

- Floating TOC on the right for rendered Markdown mode

  - Based on the idea from [here](https://discourse.joplinapp.org/t/toc-as-the-sidebar/5979/34)

  - Requires `[[toc]]` in note content

- Show/hide line numbers in CodeMirror

  - Based on the idea from [here](https://discourse.joplinapp.org/t/option-to-show-line-numbers-in-editor/8313/22)

- Changed visibility of some UI elements by default

  - Can be adapted manually - see [UI tweaks](#ui-tweaks)

### Screenshots

#### Light Theme

![Light Theme](./assets/main-light.png)

#### Dark Theme

![Dark Theme](./assets/main-dark.png)

## Installation

### Manual

- Download the latest released stylesheets (`userchrome.css` and `userstyle.css`) from [here](https://github.com/benji300/joplin-wanaka-ui/releases)

- Open Joplin and navigate to `Help > Open profile directory`

- Copy the downloaded stylesheets into the opened user profile directory

- Restart Joplin to see the changes

## UI tweaks

- Open Joplin and navigate to `Tools > Options > Appearance`

- Click `Show Advanced Settings`

- Click `Edit` below `Custom stylesheet for rendered Markdown` to open `userstyle.css` in a text editor

- Click `Edit` below `Custom stylesheet for Joplin-wide app styles` to open `userchrome.css` in a text editor

- Search for `TWEAK` and change the styles as described if you want

- Save your changes and restart Joplin to see the changes

## Feedback

If you need help or found a bug, open an issue on [GitHub](https://github.com/benji300/joplin-wanaka-ui/issues).

## Support

You like this theme as much as I do and it improves your daily work with Joplin?

Then I would be very happy if you buy me a beer via [PayPal](https://www.paypal.com/donate?hosted_button_id=6FHDGK3PTNU22) :wink::beer:

## Changes

See [CHANGELOG](./CHANGELOG.md) for details.

## License

Copyright (c) 2021 Benjamin Seifert

MIT License. See [LICENSE](./LICENSE) for more information.