View the full Documentation for more detailed information about Skribi's features.
Skribi implements live Eta templating in Obsidian in a manner (vaguely) akin to Scribunto, the scripted template framework used by MediaWiki. Create a template, pass variables to it, and render the output in your notes.
Skribi enables non-destructive templating: seamlessly integrate complex HTML into your notes, instanced from a single source, without HTML clutter or having to repeat yourself. You can even construct normally impossible element structures, such as rendering markdown inside of block elements - including Obsidian syntax media embedding. Inside a skribi, you have access to Eta's powerful templating tools and javascript, letting you imbue your template objects with dynamic behaviours.
Warning: Some features of Skribi involve the evaluation of javascript within the Obsidian process, including the evaluation of javascript in markdown files. Loading a template, script, or markdown file from an untrusted source is a security risk.
Skribi recognizes inline code elements with curly brackets {} and codeblocks of type skribi. The contents are processed and the result is rendered in the place of the code element. The output is updated automatically as you make changes.
These render very quickly - without any scripting that causes a delay (like file reads), skribi render times are practically instant. Because they are rendered asynchronously, many skribis can be placed in a document without delaying a note's rendering.
Skribi has two primary modes: template and non-template. Templates are loaded from files in the configured template folder, and invoked with a colon. They may then be followed by pipe-separated values. Note that any pipes in the values must be escaped. Here is a simple example of a template, invoking the template, and its output in preview mode.
But you can also use Skribi without templates, for example: {= sk.ctx.file.basename} will render the file name. See Skribi Syntax for the types of inline and block tags.
After being evaluated, the output is rendered to obsidian markdown, including wikilinks, images and even transclusions. Skribis inside of transclusions are processed as well. You may even invoke a skribi from within a skribi.
- More ways to pass template values in other formats (rest, arrays, anonymous, etc)
- Function to export a skribi as an HTML string (for static archival or something)
- Recursion limit setting (currently locked to 5)
- Syntax highlighting (maybe)
Skribi means 'write' in Esperanto, which is the origin of Eta's name, which means 'tiny'. Scribunto means 'they will write' in Latin. "Skribos" is a more accurate translation, but I think Skribi sounds better (pronounced 'skree-bee').