notion-enhancer/DOCUMENTATION.md

documentation

ended up here? this is a wip version of the enhancer, and this file is yet to be completed. if you're interested in using the project, switch back to the master branch. for support, contact me on discord dragonwocky#8449 or open an issue here in the repo.

want to contribute? check the contribution guidelines.

module creation

to understand best how notion's app works, check out the electron docs and explore the contents of your local extracted app.asar.

look through the existing modules for examples of implementing the stuff described below.

testing modules requires running a dev version of the enhancer (again, see the contribution guidelines). a better system is in the works.

each directory in the mods folder is considered a module, with the entry points mod.js and styles.css.

file	description
mod.js	required: describes the module and contains functional javascript
styles.css	optional: css file automatically inserted into each app window via the enhancement:// protocol

a module that with the primary function of being a hack should be categorised as an extension, while a module that with the primary function of adding styles should be categorised as a theme in the mod.js type setting.

mod.js

// not valid js!
// a visual representation of the contents/type
// of this file's exported object.
module.exports = {
  id: String of uuidv4,
  name: String of short_name,
  tags?: Array<String> of categories,
  desc: String of markdown,
  version: String of semver,
  author: String of github_username,
  options?: Array<{
    key: String,
    label: String,
    type: String in ['toggle', 'select', 'input', 'file'],
    value: Boolean or Array<String> or String or null
  }>,
  hacks?: {
    [k: 'insert-point' (e.g. 'main/createWindow.js')]: function (store) {}
  }
};

key	value	type
id	required: uuidv4	string
name	required: short name (e.g. 'frameless window')	string
tags	required: categories/type (e.g. 'extension', 'theme', 'light', 'dark')	array<string>
desc	optional: 1-3 sentence description of what the module is/does, with basic markdown support.	string
version	required: semver (e.g. '0.3.7')	string
author	required: github username	string
options	optional: see below: options made available in the enhancer menu (accessible from the tray)	array<object>
hacks	optional: see below: code inserted at various points	object

options

key	value	type
key	required: key to save value to the mod store	string
label	required: short description/name of option to be shown in menu	string
type	required: input type (see below)	string
value	optional: default or possible value/s for option	see below

type	value
toggle	boolean
select	array<string>
input	string
file	none

hacks

each "hack" is a function taking 2 arguments.

1. the store argument, which allows access to the module settings/options defined in mod.js (those set in the menu, or used internally by the module). each module store is automatically saved to + loaded from ~/.notion-enhancer/id.json. it can be initialised/accessed with store({ defaults }), then used as if it were a normal object.
2. the __exports argument, which is the module.exports of the file being modded. this can be used to call or replace functions from notion.

this hack is applied to whichever file (.js-only) is set as the function key. these can be found within the app folder.

files under the main folder are executed on app launch in a process shared between all app windows (consider it a backend). files under the renderer folder are executed on window launch in a pre-window process: the client-side javascript normally expected to run on a webpage.

unless scripts need to change app logic (e.g. to add the tray menu), they should usually be applied to renderer/preload.js to interact with the app window itself.

e.g.

// sayhi.js
module.exports = function (store, __exports) {
  document.addEventListener('readystatechange', (event) => {
    if (document.readyState !== 'complete') return false;
    console.log(store({ name: 'dragonwocky' }).name);
  });
};
// mod.js
module.exports.hacks = {
  'renderer/preload.js': require('./sayhi.js'),
};

the enhancement:// protocol

any files within the mods folder can be used via the enhancement:// protocol.

for example, accessing an image file within the frameless mod: <img src="enhancement://frameless/minimise.svg">.

styles.css

styles can be used for custom element insertions, generally hiding/re-spacing elements, and particularly: colour theming.

the enhancer has been designed with theming in mind, so as much of notion's colours and typography as possible (both for the light and dark themes) have been mapped out using css variables - check these out in the mods/core/theme.css and mods/dark+/styles.css files.