joplin-plugin-math-mode 0.5.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Caleb John
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,100 @@
+# Math Mode
+A plugin for inputting and evaluating math in markdown code blocks. It's built on top of the excellent [mathjs](https://mathjs.org/), 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](https://github.com/CalebJohn/joplin-math-mode/blob/main/examples/euro_trip.png)
+
+
+Try some of these!
+
+	= derivative('x^2 + x', 'x')
+	
+	= 5cm + 0.2 m in inch
+	
+	= i^2
+
+	= 10.15 USD to CAD
+	
+	```math
+	M = [1, 3; 4, 6]
+	
+	size(M)
+	transpose(M)
+	diag(M)
+	det(M)
+	```
+	
+	```math
+	combinations(6, 3)
+	permutations(6, 3)
+	```
+
+View all examples in [the examples folder](https://github.com/CalebJohn/joplin-math-mode/blob/main/examples). If you have an example of your own, please consider adding it to the examples directory, or sending it my way to have added. Thanks!
+
+Plus [many more functions](https://mathjs.org/docs/reference/functions.html) provided by mathjs.
+
+
+# Installation
+- Go to `Tools -> Options -> Plugins`
+- Search for "Math Mode" in the search box
+- Click Install and restart Joplin
+
+# Configuration
+Math Mode supports a small number of settings that can be adjusted by placing a "config line" inside a math block. The defaults can be changed under Tools -> Options -> Math Mode (Preferences on MacOS). The supported settings are (defaults listed first):
+
+	```math
+	global: no | yes
+	simplify: no | yes
+	bignumber: no | yes
+	displaytotal: no | yes
+	hide: no | expression | result
+	verbose: yes | no
+	inline: yes | no
+	notation: auto | exponential | engineering | fixed 
+	precision: Any number between 0 and 16
+	align: left | right
+	```
+
+Where
+`global` determines if the following settings (within the same block) will apply to all the following blocks (and code lines).
+
+`simplify` will direct the math engine to simplify rather than solve expressions. This does not work with most expressions so use with caution.
+
+`bignumber` will us the mathjs [`BigNumber`](https://mathjs.org/docs/datatypes/bignumbers.html) with 128 bit precision. `bignumber` and `simplify` are incompatible.
+
+`displaytotal` rather than showing the result of a line, showing the running total of the block.
+
+`hide` will hide either a math expression or result.
+
+`verbose` determines if just the result of the expression should be shown, or the variable name as well.
+
+`inline` should the result be placed on the same line as the expression, or below.
+
+`notation` passed to the [mathjs format function](https://mathjs.org/docs/reference/functions/format.html#where), this is the numerical format to use for results.
+
+`precision` the number of decimal places to show, 0 to show all. See [mathjs docs](https://mathjs.org/docs/reference/functions/format.html).
+
+`align` place the result on the left or right of the editor window.
+
+# Roadmap
+### TODO
+- [ ] Add a markdown-It renderer plugin to get the output on both views
+- [x] Add syntax or a method for sum calculations
+- [x] Add configuration to settings menu
+
+### Ideas
+There is no plan to implement any of these ideas, but there might be eventually.
+- [ ] Support input in latex format (and maybe in $...$)
+		- Maybe also support just saving math into a latex format (this is easier with mathjs)
+- [ ] Fix math mode greedily highlighting after \`\`\`math (probably need a custom mode)
+
+
+---
+
+
+Inspired by [literate-calc-mode](https://github.com/sulami/literate-calc-mode.el) for emacs by [sulami](https://github.com/sulami)
+
+Thanks to the European Central Bank for [providing daily exchange rates](https://www.ecb.europa.eu/stats/policy_and_exchange_rates/euro_reference_exchange_rates/html/index.en.html)
+
+This project uses icons (without modification) which are provided free under the [CC BY 4.0 License](https://fontawesome.com/license/free) by the Font Awesome project.

package/examples/README.md

@@ -0,0 +1,29 @@
+# Basic
+## Road Trip
+An example of using the calculations while planning. A basic plugin using simple arithmetic across multiple code blocks.
+![example of planning a road trip](./road_trip.png)
+
+## Monthly Budget
+An example showing the usage of the `total` variable. Any continuous block of calculations will be added together into a `total`. This example also demonstrates the `displaytotal` config option.
+![example of a monthly budget](./monthly_budget.png)
+
+## What I Owe Mom
+Another `total` example that demonstrates the explicit addition and summation syntax for the `total` variable.
+![example of splitting bills](./what_i_owe_mom.png)
+
+## Euro Trip
+Example that demonstrates the use of currency conversion. Also uses the `total` variable to sum up the daily cost of a trip.
+![example of foreign trip planning]('./euro_trip.png)
+
+
+# Advanced
+## Burger
+An example of a recipe with a configurable number of portions, demonstrating unit handling and some settings.
+![burger recipe with math blocks](./burger.png)
+
+## Compound Interest
+An example that uses math to demonstrate the power of compound interest. This example demonstrates some of the more advanced features of mathjs.
+![compound interest calculations](./compound_interest.png)
+
+
+

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "joplin-plugin-math-mode",
+  "version": "0.5.3",
+  "homepage": "https://github.com/CalebJohn/joplin-math-mode",
+  "description": "",
+  "scripts": {
+    "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
+    "prepare": "npm run dist",
+    "update": "npm install -g generator-joplin && yo joplin --update"
+  },
+  "keywords": [
+    "joplin-plugin",
+    "calculator",
+    "mathjs"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^14.0.14",
+    "chalk": "^4.1.0",
+    "copy-webpack-plugin": "^6.1.0",
+    "fs-extra": "^9.0.1",
+    "glob": "^7.1.6",
+    "on-build-webpack": "^0.1.0",
+    "tar": "^6.0.5",
+    "ts-loader": "^7.0.5",
+    "typescript": "^3.9.3",
+    "webpack": "^4.43.0",
+    "webpack-cli": "^3.3.11",
+    "yargs": "^16.2.0"
+  },
+  "dependencies": {
+    "mathjs": "^8.1.1"
+  }
+}

package/plugin.config.json

@@ -0,0 +1,6 @@
+{
+	"extraScripts": [
+		"mathMode.ts",
+		"exchangeRate.ts"
+	]
+}

package/publish/plugin.calebjohn.MathMode.json

@@ -0,0 +1,18 @@
+{
+	"manifest_version": 1,
+	"id": "plugin.calebjohn.MathMode",
+	"app_min_version": "1.8",
+	"version": "0.5.3",
+	"name": "Math Mode",
+	"description": "Turn your notes into a powerful calculator with inline math.",
+	"author": "Caleb John",
+	"homepage_url": "https://github.com/CalebJohn/joplin-math-mode#readme",
+	"repository_url": "https://github.com/CalebJohn/joplin-math-mode",
+	"keywords": [
+		"calculator",
+		"math",
+		"mathjs"
+	],
+	"_publish_hash": "sha256:4b790d5e91c44a3a2739e63711b2ecd6a74ae0943fcfddfe3382d450fc9ce1be",
+	"_publish_commit": "main:fc3e1fe29428081143e85b7e41127a66f772bd3e"
+}