Skip to content

Symbat 1.0.1

Choose a tag to compare

@github-actions github-actions released this 03 Aug 19:00
· 15 commits to main since this release

Some minor fixes to comply with Obsidian's automatic plugin review! Take a look at all the great features from the 1.0.0 release!


Symbat integrates the wonderful Numbat into Obsidian for intereactive, unit-aware, scientific calculation! Key features are:

  • Full Numbat Support: Numbat is an amazing scientific calculator with units support, and Symbat is fully compatible with its syntax, semantics, and type system. You can check out the official documentation, as well as the tutorial and syntax reference for more information.
  • Notebook-Style Workflow: You can write numbat code in code blocks inside your standard markdown notes that evaluate and render across source mode, live preview, and reading mode. numbat blocks provide isolated contexts, while numbat-shared blocks share state with other such blocks. Evaluation is always replayed in order, so there are no IPython-style evaluation order concerns.
  • Inline Evaluation: You can write numbat expressions in the middle of lines, getting live results as you type. An expression like n`5 km + 3 mi` inlays the result as virtual text, which you can click to bake the value into your notes. An expression like nc`10 cm + 3 in ...` computes the result continuously into the note after a .
  • Note Properties Integration: Note properties can be given the Numbat type, which turns its value into a fully-interactive numbat expression bound into the note's scope. A property distance: 21.1 km makes the query distance -> mi work in any Numbat scope in the note. Nested YAML objects are bound as Numbat structs, which works very well with Better Properties.
  • Imports and Preludes: Symbat lets you numbat-use other notes in your frontmatter to import their properties and shared blocks into your note. You can also specify custom .nbt files as preludes that will be loaded for every context.
  • Interactive Evaluation: Symbat highlights results, errors, and hints inline as you type as inlay hints. You get a truly interactive notebook experience, no matter where you are evaluating Numbat code: it works in properties, inline expressions, blocks, and even Bases cells. Symbat also comes with a REPL that lives in the sidebar, with history, live highlighting, and Numbat's built-in interactive commands.
  • Unicode Completions: Math tends to make heavy use of unicode symbols, so Symbat has integrated Numbat's unicode completer to make typing such things far easier. \alphaα, \piπ, \_2 as you type, without any need to think, and it even plays nicely with Typing Transformer and Shiki.

Not just a Numbat notebook, Symbat integrates a whole host of features for the power user. There is completion for identifiers, keywords, units, dimensions, and types, with signature and documentation help shown clearly, and that works in every context where you can write Numbat code. There is comprehensive hover support, showing information for a symbol you point the mouse at or rest the caret on. Syntax highlighting works in every Numbat expression, providing rich semantic highlighting as you work.

This is accompanied by a notebook scope inspector, which shows every binding that the note contains, allowing you to see its current value and click through to its definition. It has a search box that both searches the note scope and lets you browse the bundled prelude. Symbat also includes an editing mode for .nbt files in Obsidian, allowing you to work with Numbat files natively with all of these power-user tools.