Skip to content

An obsidian plugin which turns a math code block into a full featured calculator

Notifications You must be signed in to change notification settings

claremacrae/obsidian-numerals

 
 

Repository files navigation

Numerals Obsidian Plugin

Numerals gives you the power of an advanced calculator inside a math code block, complete with currencies, units, variables, and math functions! Now you can perform calculations inline with your notes, and see both the input and the evaluated result. Numerals works with Live Preview as well as Reader view. Math expressions can be commented with #, or descriptive sentences can be added between calculations. Numerals Lemonade Stand -Side By Side - 11-6

Features

  • Units
    • 1ft + 12in2ft
    • 20 mi / 4 hr to m/s2.235 m / s
    • 9.81 m/s^2 * 100 kg * 40 m39.24 kJ
  • Currency
    • $1,000 * 22,000 USD
    • £10 + £0.7510.75 GBP
  • Math functions
    • sqrt, sin, cos, abs, log, etc (see mathjs for full list)
  • Hex, Binary, Octal, and other bases
    • 0xff + 0b100259
    • hex(0xff + 0b100)"0x103"
  • Natural Constants

Numerals utilizes the mathjs library for all calculations. Numerals implements a preprocessor to allow more human-friendly syntax, such as currency symbols and thousands separators. For all available functions and capabilities (which includes matrices, vectors, symbolic algebra and calculus, etc), see the mathjs documentation

Style Options

Numerals has been tested with the default theme and most other top themes. It uses default values such that it should play nice with any other theme. There are 3 options to choose from:

Layout

2-panes

  • Answer is shown to the right of the input with a background color and a seperator.
  • Distinctive style that seperates input from evaluated answers

Numerals 2 Panes - 11-6

Answer to the Right

  • Answer to the right: answer is shown in the same line as the input, but right-aligned
  • More subtle than 2-panes that works well with just a few calculations

Numerals answer right - 11-6

Answer Below

  • Answer is shown below the input, on the next line.
  • Less compact vertically, but more compact horizontally

Numerals answer below - 11-6

Alternating Row Colors

Choose between a consistent code block background color (left), or alternating rows to help track from input to result (right).

Numerals Alternating Row Style Comparison

Installation

Numerals is not yet in the Obsidian community plugin list. The easiest way to try Numerals is by using the Obsidian BRAT plugin.

Using BRAT

  1. Ensure BRAT is installed
  2. Trigger the command Obsidian42 - BRAT: Add a beta plugin for testing
  3. Enter this repository, gtg922r/obsidian-numerals
  4. Activate Numerals plugin in community plugin list

Remaining features in progress

  • Support for mapping currency symbols to different currencies (currently $ maps to USD)
  • Better Error handling (currently no indication of error line)
  • Style Settings support for all colors and other style options
  • Syntax highlighting of input
  • Support for additional currency symbols (currently only supports $) (added in 0.0.9)

Related

There are a number of other plugins that address math and calculation use cases in Obsidian.

There are also a number of "calculator as notes" apps that acted as the inspiration for Numerals. If you are looking for a purpose-built app outside of Obsidian, consider:

About

An obsidian plugin which turns a math code block into a full featured calculator

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 57.9%
  • CSS 25.8%
  • JavaScript 16.3%