The Numerals plugin is a powerful tool that enables users to perform mathematical calculations and insert the results into their Obsidian notes. With this plugin, you can write complex math expressions in Markdown code blocks and evaluate them instantly. The plugin also offers advanced features such as result annotation, autocompletion of functions and variables, and style settings for customization. Additionally, Numerals supports mapping currency symbols to different currencies and allows users to specify the format of rendered results. Overall, this plugin is an excellent choice for anyone who needs to perform complex calculations or visualize data in their Obsidian notes.
🚀 Numerals 1.5 - Biggest Update Yet! 🚀
Introducing some of the most requested features including the ability to:
- sum previous lines with
@sumor@total - reference note frontmatter properties
- use global variables between blocks
- insert calculation results directly into your notes
Also new convenience features such as Greek letter auto-completion and custom currency support. Upgrade now and take your note-taking calculations to the next level!
Detailed Updates
⭐️ Sums and Totals of Previous Lines
- New feature and syntax for summing a group of lines:
@sumor@total(closes #18, #49, #36) - When Numerals encounters
@totalor@sumit inserts the sum of all previous lines up until the last blank line or comment - Can use in a calculation or unit conversion
⭐️ Values in Note Frontmatter
Numerals can now reference note frontmatter or dataview inline values. Set the numerals property on a page to share specific properties with all math blocks on a page.
In order to access metadata, you need to tell Numerals to make the value available by:
- Set the
numeralsmetadata value (either frontmatter or dataview inline property) to the name of the value you want to include, or a list of values- Frontmatter of
numerals: other_metadata_name, ornumerals: [metadata_1, metadata_2] - inline value:
[numerals:: other_metadata_name]
- Frontmatter of
- Set the metadata value of
numeralstoall: will index all metadata and make it available to dataview - Enable "Always Process All Frontmatter" in the Numerals settings
Numerals is able to write back to dataview values, through use of Result Insertion
⭐️ Note-wide Global Variables
Any variable name preceeded by an $ symbol will be made available to all math blocks on a page (closes #34)
⭐️ Result Insertion - Store Results in Raw Text
Using the new @[...] syntax (for example: @[profit]), Numerals will insert the results of a calculation into the raw text of your notes. (closes #22)
⭐️ Greek Letter Auto-complete
- Add greek letter auto-completion after typing
:. e.g.:muin a math block will offerμas an auto-complete suggestion (closes #69) - Greek letters can be used in any variable name. They also work with subscripting when in
math-texblock.
⭐️ Custom Currency Support
- Add custom currency support. In Numerals setting, user can set a currency symbol and name. (closes #54, #52, #61)
- Allows for example:
₿100 / day * 3 hours → 12.5 BTCif you set ₿ as the custom currency:
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, and offers TeX-style rendering or Syntax Highlighting as well as auto-completion suggestions. Comments or explanations can be added with #, and important results can be indicated with => after the calculation.
Features
- Units
1ft + 12in→2ft20 mi / 4 hr to m/s→2.235 m / s100 km/hr in mi/hr→62.137 mi / hr9.81 m/s^2 * 100 kg * 40 m→39.24 kJ
- Currency
$1,000 * 2→2,000 USD£10 + £0.75→10.75 GBP$100/hr * 3days→7,200 USD- Set custom currencies, for example
₿
- Math functions
sqrt,sin,cos,abs,log, etc (see mathjs for full list)
- Hex, Binary, Octal, and other bases
0xff + 0b100→259hex(0xff + 0b100)→"0x103"
- Natural Constants
e,i,pi,speedOfLight,gravitationConstant,vacuumImpedance,avogadro- And many more (see mathjs: Constants and mathjs: Units for more)
- Auto-complete suggestions
- By default will offer auto-complete suggestions for any variables defined in a math codeblock being edited
- Optional setting to include all available functions, constants, and physical constants
- Totals of previous lines using
@totalor@sumspecial operator- When Numerals encounters
@totalor@sumit inserts the sum of all previous lines up until the last blank line or comment
- When Numerals encounters
- Greek Letters
- Variables can be named using greek letters, e.g.
μ = 3 m/s - Greek letters can be auto-completed by typing
:, e.g.:muin a math block will offerμas an auto-complete suggestion
- Variables can be named using greek letters, e.g.
- Note-Global Variables
- Any variable name preceeded by an
$symbol will be made available to all math blocks on a page
- Any variable name preceeded by an
- Fractions:
fraction(1/3) + fraction(1/4)→7/12
- Comments and Headings:
#at the end of a line will be ignored, but rendered in faint text as a comment- A line starting with
#will be ignored by the math engine, but will be bolded when rendered
- Result Annotation:
=>at the end of a line (but before a comment) will tell Numerals that a result should be highlighted. Any line in that code block without a=>annotation will be rendered faintly (or hidden depending on settings).
- Result Insertion:
- Using the
@[...]syntax (for example:$[profit]), Numerals will insert the results of a calculation into the raw text of your note, following:: - Uses dataview notation, which allows writing back to dataview values. For example,
@[profit]will be modified to say@[profit::10 USD]
- Using the
- Access Frontmatter Properties
- Numerals will have access to any property name specified in the
numerals:property. Settingnumeralstoall, will make all properties in a note available to Numerals - Multiple properties can be specified as a list, e.g.
numerals: [apples, pears]will makes both theapplesandpearsproperty available to Numerals
- Numerals will have access to any property name specified in the
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
Styling 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 also several configurable settings to modify how Numerals renders math blocks
Render Style
Numerals supports rendering inputs/ouputs as either:
- Plain Text
- TeX
- Syntax Highlighting
One of these options can either be chosen as a default from Numerals settings, or then can be applied on a per-block basis by using math-plain, math-tex, or math-highlight rather than a math code block.
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
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
Answer Below
- Answer is shown below the input, on the next line.
- Less compact vertically, but more compact horizontally
Alternating Row Colors
Choose between a consistent code block background color (left), or alternating rows to help track from input to result (right).
Auto-completion Suggestions
By default, Numerals will provide auto-completion suggestions for variables that have been defined in a particular math codeblock. Turning on Include Functions and Constants in Suggestions will also provide suggestions for all functions, math constants, and physical constants supported in Numerals.
Format of Numbers in Rendered Results
Numerals allows the user to specify the format of rendered results.
- System Formatted (Default): Use your local system settings for number formatting (including thousands and decimal separator)
- Fixed: No thousands separator and full precision. Period as decimal separator (e.g.
100000.1) - Exponential: Always use exponential notation. (e.g.
1.000001e5) - Engineering: Exponential notation with exponent a multiple of 3. (e.g.
100.0001e3) - Formatted: Forces a specific type of formatted notation.
- Style 1:
100,000.1 - Style 2:
100.000,1 - Style 3:
100 000,1 - Style 4:
1,00,000.1
- Style 1:
Installation
Numerals can be found in the Obsidian community plugin list.
Using BRAT
To try the latest features of Numerals before they are released, and provide helpful feedback and testing, try Numerals by using the Obsidian BRAT plugin. All new Numerals features will be pushed to beta testers first.
- Ensure BRAT is installed
- Trigger the command
Obsidian42 - BRAT: Add a beta plugin for testing - Enter this repository,
gtg922r/obsidian-numerals - Activate Numerals plugin in community plugin list
Features in progress and roadmap
- Support for mapping currency symbols to different currencies (#17)
both$and¥can be mapped to different currencies in settings - Style Settings support for all colors and other style options (#13)
- Partial support added in 1.0.5
- Result annotation, similar to Calca feature (#4)
- Support added in 1.0.5
- Autocompletion of functions and variable inside math code block (#15)
- Support added in 1.0.8
- Inline calculation for inline code blocks (#5)
Feel free to suggest additional features by creating an issue!
Related
There are a number of other plugins that address math and calculation use cases in Obsidian.
- If you are primarily interested in evaluating math expressions and inserting the result into your notes, look into meld-cp/obsidian-calc
- If you are looking for a full-featured Computer Algebra System including plots and with similar code block rendering, consider Canna71/obsidian-mathpad: Computer Algebra System (CAS) for Obsidian.md
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: