Skip to content

Commit

Permalink
improve readme and add changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
pchorus committed Aug 17, 2019
1 parent 42f16d8 commit 22fb453
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 1 deletion.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
$$
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down

0 comments on commit 22fb453

Please sign in to comment.