From 22fb453a07ace6cc9f8b272caccadafd7de28f96 Mon Sep 17 00:00:00 2001 From: Pascal Chorus Date: Sat, 17 Aug 2019 23:08:57 +0200 Subject: [PATCH] improve readme and add changelog --- CHANGELOG.md | 7 +++++++ README.md | 15 +++++++++++++++ package.json | 2 +- 3 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..6c8bc31 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +#Change Log + +## 0.1.1 (2019-08-17) +Add this change log and improve README.md + +## 0.1.0 (2019-08-17) +Initial implementation of plugin. diff --git a/README.md b/README.md index 3960bc9..d0fb5b7 100644 --- a/README.md +++ b/README.md @@ -79,3 +79,18 @@ module.exports = { } } ``` + +### Adding Math Equations to your markdown files + +To insert a math expression in your text, put your katex math expression in $, e.g. +```markdown +The example for an inline math expression is $ (a+b)^2 = a^2 + 2ab + b^2 $. +``` + +To insert a math expression on its own line horizontally centerd, put your katex math expression in $$ with line breaks, e.g. +```markdown +The example for a math expression: +$$ +(a+b)^2 = a^2 + 2ab + b^2 +$$ +``` diff --git a/package.json b/package.json index b3c8966..52d5f50 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "gridsome-remark-katex", - "version": "0.1.0", + "version": "0.1.1", "description": "Gridsome remark support for math equations using remark-math and katex", "main": "index.js", "repository": {