Giter Club home page Giter Club logo

joplin-theme's Introduction

My personal userchrome.css and userstyles.css for Joplin.

Built upon Amanda's theme (thanks for help on the forum!) and highly inspired by the Things 3 app for Mac/iOS as well as some details i liked myself, and specially built to support my daily GTD (Getting Things Done) workflow. Some details about my setup below.

screenshot1.png

Details:

These are the resources i added to my theme. The setup section will guide you on how to install it.

  • Dark theme: based on the default Joplin dark theme and, as stated before, on Amanda's theme.
  • Colorscheme: i call it Neptune, i use it on many things on my setup (Linux rice, Vim colors, and other applications).
  • Custom CSS for the app interface and markdown editor (userchrome.css) and for the rendered notes (userstyles.css)
  • Support for icons (FontAwesome and Material Design Icons).
  • Other stuff i modified/added:
    • Colored icons on sidebar (based on the Things 3 app);
    • Capitalized tags (also support for icons in tags);
    • Colored tables, glyphs and text on rendered notes;
    • Custom styles for checkboxes.

Setup:

Following are the instructions if you want to replicate my theme, and the things you need to make it work.

  1. You need two fonts with the FontAwesome and Material Icons glyphs, one sans-serif and one monospaced. The sans i use in all the titles and pretty much the rest of the theme, and the monospaced is used, obviously, on the markdown editor. You can get fonts patched with both glyphs (and more) using any of the Nerd Fonts, you can download any of them on the website, or you can patch your own. I patched mine (I use Google Sans as sans and Roboto Mono as monospaced).

  2. Download the files. Open userchrome.css and userstyles.css and edit the fonts, replacing it with the font families of the ones you are going to use.

  3. Copy userchrome.css and userstyles.css to your joplin-desktopfolder (on Linux, it is located in ~/.config/joplin-desktop), on Windows you can check the location clicking on Tools > Options > General and reading it on the first line.

  4. Don't forget to make sure you are using the Dark theme for Joplin. In case you are not, set it clicking on Tools > Options > Appearance and select Dark in the Theme dropdown menu.

  5. Done! The theme is set up.

Usage:

Icons:

  • The colored icons on sidebar: This is a very (kinda messy) workaround that works for me, on my setup, and i was able to "implement" this setting some classes using the parameters :after and before on the userchrome.css, so when you open your Joplin, it will have these icons floating on your sidebar. Yu can find it on the following section:
/* Colored icons on the sidebar */  
.list-item div:before {  
    font-family: var(--font-sans) !important;  
    font-size: 16px !important;  
    content: '๏€…';  
    position: absolute;  
    left: 33px; top: 129px;  
    width: 20px;  
    color: var(--yellow);  
}   
[ ...]  
/* Colored icons ENDS HERE */

So if you are not going to use it, you can remove or comment out the entire section. If you are going to use it, adjust the glyps, colors and position for every one of them (i know, it is a lot of work, but i found it worth it to set to have this setup ๐Ÿ™‚)

  • FontAwesome and/or Material Icons on sidebar, notebook titles, note titles, notes body, tags, and so on:

You need to get your icons from the cheatsheet, you can find it on Nerd font's website here. Just search some icon you would want to use it (or navigate through it), copy it and paste it on Joplin. Tip: i keep some of which i most use on a note inside my Joplin, for future use, it is easier.

Screenshots:

Notebooks section

screenshot2.png

Notes section

screenshot3.png

Rendered markdown

screenshot4.png

Custom checkboxes

screenshot5.png screenshot6.png
screenshot7.png screenshot8.png

You can set it on userstyle.css, just replace the glyphs for anyone you like it from FontAwesome or Material Icons, on the following section

/* checkbox aspect */
li.md-checkbox [type="checkbox"]:not(:checked) + label:before,
li.md-checkbox [type="checkbox"]:checked + label:before {
    content: '๏˜ฐ'; /* Unchecked glyph*/
    position: absolute;
    left: 0; top: -3px;
    width: 1em; height: 1em;
    border: 1px solid var(--black);
    background: var(--black);
    border-radius: 1px;
}

/* checked mark aspect */
li.md-checkbox [type="checkbox"]:not(:checked) + label:after,
li.md-checkbox [type="checkbox"]:checked + label:after {
    content: '๏˜ฑ'; /* Checked glyph*/
    position: absolute;
    left: 0; top: -3px;
    width: 1em; height: 1em;
    border: 1px solid var(--black);
    background: var(--black);
    border-radius: 1px;
    transition: all .2s;
}

Notes

If you have any questions, feel free to ask, you can reach me on the Joplin's forum, i'm user @hrqmonteiro there!

Tipjar

If you want to support my work, you can donate, it would be very appreciated!

BTC: 35MVD6xjhTh9hsQ1TYJRbHDDYL7Tf3BmbN
Paypal: Donate

joplin-theme's People

Contributors

hrqmonteiro avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.