Skip to content

laurent22/joplin-math-mode

 
 

Repository files navigation

Math Mode

A plugin for inputting and evaluating math in markdown code blocks. It's built on top of the excellent mathjs, meaning it can be used to perform symbolic calculation, vector math and can even handle units!

So what can it do? It's better to demonstrate with an example.

Screenshot of using math mode to plan a road trip

Try some of these!

= derivative('x^2 + x', 'x')

= 5cm + 0.2 m in inch

= simplify(3 + 2/4)

= i^2

```math
M = [1, 3; 4, 6]

size(M)
transpose(M)
diag(M)
det(M)
```

```math
combinations(6, 3)
permutations(6, 3)
```

Plus many more functions provided by mathjs.

Installation

  • Download the release .jpl file from here
  • Install the downloaded plugin via Tools -> Options -> Plugins in Joplin
  • Remember to restart Joplin

Roadmap

TODO

  • Add insert button on context menu for all math lines (can also be done at the block level)
  • Support an "insert all commands in note" from the menu

Maybe do

  • Support input in latex format (and maybe in $...$) - Maybe also support just saving math into a latex format (this is easier with mathjs)
  • Add a markdown-It renderer plugin to get the output on both views - Toggle view of equation/results/both
  • Fix math mode greedily highlighting after ```math (probably need a custom mode)
  • Support BigNums/derivatives and other advanced operations more ergonomically
  • Toggle the display format of results (newline/endline) (include variable name or not)
  • Add global settings to the settings menu, and support local (file or block) settings using frontmatter

Inspired by literate-calc-mode for emacs by sulami

About

A calculator for Joplin's code blocks.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 85.6%
  • JavaScript 14.4%