Skip to main content

Get ready to customize MarginNote

Before MarginNote 5 (that is, in MN3 and MN4), the main way to customize MN was through classic add-ons. Starting with MN5, you can go much further with the new scene add-ons, and you can bundle your add-ons together with assets and configuration by using a MarginNote scene template.

What is a MarginNote scene template?

A MarginNote scene template (also called an MN scene template, MN template, scene template, or simply template in this documentation) is a feature introduced in MarginNote 5. Templates are designed to help you build a personal study and work flow, stay focused on one concrete step or scenario at a time, and push each scenario as far as it can go. Concretely, every template consists of three parts: template configuration, add-ons, and samples.
  • Template configuration: tools and modes, the top toolbar, excerpt and card menus, floating windows and the floating ball, enabled add-ons, behavior settings, and more.
  • Add-ons: you can enable either scene add-ons or classic add-ons. Add-ons can define their own behavior and interface, which makes highly personalized setups possible.
  • Samples: study material or demo content shipped with the template. Samples should help users get productive with the template quickly.
  • On top of these, every template must contain a manifest.json so that MN can recognize and list it.
Note that all three parts are optional. In other words, the smallest possible scene template can contain nothing at all, in which case it behaves exactly like immersive mode.