HTML Templates

Unlike Neuron, Emanote’s generated HTML can be completely customized. Emanote uses the Heist HTML template system that supports non-trivial constructs like recursion; see here for a tutorial on its syntax.

The default HTML templates are stored in the default layer, which can you override either totally or in subset.

Layouts

Emanote includes two builtin layouts, called book (the default) and `note`, but you can also write your own HTML layout from scratch, as long as you specify that template in YAML configuration for the notes in question. For eg., templates/home.tpl is how https://srid.ca homepage is generated, because its index.md specifies this template as template.name in its YAML frontmatter (which could also be index.yaml).

Features

Links to this page

Sidebar

In the `book` template, the sidebar is rendered on the left side. The sidebar tree is determined from the directory layout of the Markdown or Org files.
Neuron-like layout

Emanote comes with two built-in HTML template layouts. The default layout is called “book”, but you may select the “note” layout (which mimics Neuron) by adding the following to your index.yaml,
Migrating from neuron

Full theming (customize HTML Templates fully)
Layer system

Emanote implicitly includes what is known as the “default” layer. Its contents can be seen here. This layer contains HTML Templates, index.yaml and other default assets, like the logo, favicon and fonts. When you run emanote -L /your/notebook run, your notebook is overlaid on top of this default layer. What this means, in effect, is that you override just about any file in the default layer, such the HTML content of HTML Templates, in your own notebook directory. As an example, see template/hooks of this documentation notbook.
Full-text search

Click the lens icon on the sidebar (if using the ‘book’ template layout) or top-right corner (if using Neuron-like layout).
External link icons

Note that the attribute can also be used to display the icons in the HTML templates (like the footer or the sidebar) or in raw HTML of Markdown ✍️.

The displayed icon may depend on the link properties (e.g. the actual URI scheme). This is customized using CSS. By default, Emanote displays a different icon if the URI scheme component is mailto:. Check the https://github.com/srid/emanote/blob/master/default/templates/base.tpl of HTML template for details.