Skip to content

torchatlas/notion-enhancer

 
 

Repository files navigation

notion-enhancer

notion.so is a pretty awesome tool already, but there's always room for improvements. it might just be a preference, it might be something crucial to your setup, it might be something users have been asking for for a long time, or it might even be something you haven't realised you need yet - there's something that would make your user experience a lot better.

this package is a mod-loader for the desktop app, with custom colour theming and extra feature enhancements.

want to contribute? check out the contribution guidelines and the documentation.

for support, join the discord server.

installation

coming from <= v0.7.0? things are a bit different - have a read of the update guide before following these instructions.

on arch linux? use the aur package: https://aur.archlinux.org/packages/notion-enhancer

otherwise:

  1. install node.js: windows/macOS, linux/WSL:
    curl -sL https://deb.nodesource.com/setup_current.x | sudo -E bash -
    sudo apt-get install -y nodejs
    a computer restart may be required here.
  2. make sure no notion processes are running (check the task manager!), and install the enhancer globally: run npm i -g notion-enhancer in the terminal/command prompt.

command-line interface

the enhancements should be automatically applied on installation and automatically removed on uninstallation.

on some platforms this may throw errors if done without elevated/admin permissions, though, so if it hasn't automatically installed you will still need to use these commands.

Usage:
  $ notion-enhancer <command> [options]

Commands:
  apply   : add enhancements to the notion app
  remove  : return notion to its pre-enhanced/pre-modded state
  check   : check the current state of the notion app

For more info, run any command with the `--help` flag:
  $ notion-enhancer apply --help
  $ notion-enhancer remove --help
  $ notion-enhancer check --help

Options:
  -y, --yes      : skip prompts (may overwrite data)
  -d, --dev      : show detailed error messages (not recommended)
  -h, --help     : display usage information
  -v, --version  : display version number

supported clients

(it can also be run from the wsl to apply enhancements to the windows app.)

using a not-yet-supported operating system or notion installation? ask for platform support.

mobile clients are not supported and due to system limitations/restrictions cannot be.

a chrome extension may be coming soon for web client support.

is this against notion's terms of service? can i get in trouble for using it?

definitely not! i contacted their support team to check, and the response was awesome:

"Thanks for taking the time to share this with us. Userscripts and userstyles are definitely cool ideas and would be helpful for many users! ... I'll also share this with the rest of the team to take to heart for future improvements."

features

once applied, modules can be configured via the graphical menu, which is opened from the tray/menubar icon or with CMD/CTRL+E.

currently all modules come pre-installed for technical reasons, security assurance, and ease-of-use. these include:

notion-enhancer core

tags: #core

description: the cli, modloader, menu, & tray.

author: dragonwocky

version: v0.8.0

option type default
hide app on open toggle no
auto-maximise windows toggle no
close window to the tray toggle yes
integrated titlebar toggle yes
height of frameless dragarea number input 15
integrated scrollbars toggle yes
window display hotkey accelerator input CommandOrControl+Shift+A

custom inserts

tags: #extension

description: link files for small client-side tweaks.

author: dragonwocky

version: v0.1.1

option type default
css insert file none
client-side js insert file none

bracketed links

tags: #extension

description: render links surrounded with [[brackets]] instead of underlined.

author: arecsu

version: v0.1.0

dark+

tags: #theme #dark

description: a vivid-colour near-black theme.

author: dragonwocky

version: v0.1.3

option type default
primary colour color rgb(177, 24, 24)

emoji sets

tags: #extension

description: pick from a variety of emoji styles to use.

author: dragonwocky

version: v0.1.3

focus mode

tags: #extension

description: hide the titlebar/menubar if the sidebar is closed (will be shown on hover).

author: arecsu

version: v0.1.0

gameish

tags: #theme #dark

description: a purple, "gamer-styled" theme with a blocky-font.

author: LVL100ShrekCultist

version: v0.1.1

neutral

tags: #theme #dark

description: smoother colours and fonts, designed to be more pleasing to the eye.

author: arecsu

version: v0.1.0

night shift

tags: #extension #theme

description: sync dark/light theme with the system (overrides normal theme setting).

author: dragonwocky

version: v0.1.0

pastel dark

tags: #theme #dark

description: a true dark theme with a hint of pastel.

author: zenith_illinois

version: v0.1.0

property layout

tags: #extension

description: auto-collapse page properties that usually push down page content.

author: alexander-kazakov

version: v0.2.2

right-to-left

tags: #extension

description: enables auto rtl/ltr text direction detection.

author: obahareth

version: v1.3.0

weekly view

tags: #extension

description: calendar views named "weekly" will show only the 7 days of this week.

author: adihd

version: v0.5.0

contributors

@TarasokUA wrote the first versions of this in python, in early 2020. a couple months after I (@dragonwocky) picked the project up, at first extending upon the original base and later moving to the javascript module system.

since then, various community members have helped out heaps - some listed as contributors here on github, but many helping with code, feedback and testing on discord and in emails.

individual modules have their original authors attributed.

About

an enhancer/customiser for the all-in-one productivity workspace notion.so

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 54.0%
  • JavaScript 45.2%
  • HTML 0.8%