Skip to content
Snippets Groups Projects
Unverified Commit d5bf730a authored by Abreto FU's avatar Abreto FU Committed by GitHub
Browse files

Merge pull request #1 from Abreto/abreto-version 

Abreto version
parents e494b209 7b804b79
No related branches found
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
LICENSE
+ 24
− 0
View file @ d5bf730a
......@@ -43,3 +43,27 @@ 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.
---
The MIT License (MIT)
Copyright (c) 2019 Abreto Fu
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.
README.md
+ 4
− 6
View file @ d5bf730a
......@@ -2,8 +2,6 @@
Add Math to your Markdown
[![Build Status](https://travis-ci.org/iktakahiro/markdown-it-katex.svg?branch=master)](https://travis-ci.org/iktakahiro/markdown-it-katex)
[KaTeX](https://github.com/Khan/KaTeX) is a faster alternative to MathJax. This plugin makes it easy to support in your markdown.
Need convincing?
......@@ -19,14 +17,14 @@ npm install markdown-it
Install the plugin
```
npm install @iktakahiro/markdown-it-katex
npm install @abreto/markdown-it-katex
```
Use it in your javascript
```javascript
var md = require('markdown-it')(),
mk = require('@iktakahiro/markdown-it-katex');
mk = require('@abreto/markdown-it-katex');
md.use(mk);
......@@ -36,12 +34,12 @@ var result = md.render('# Math Rulez! \n $\\sqrt{3x-1}+(1+x)^2$');
Include the KaTeX stylesheet in your html:
```html
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.10.0/katex.min.css">
<link rel="stylesheet" href="https://cdn.bootcss.com/KaTeX/0.11.1/katex.min.css">
```
If you're using the default markdown-it parser, I also recommend the [github stylesheet](https://github.com/sindresorhus/github-markdown-css):
```html
<link rel="stylesheet" href="https://cdn.jsdelivr.net/github-markdown-css/2.2.1/github-markdown.css"/>
<link rel="stylesheet" href="https://cdn.bootcss.com/github-markdown-css/3.0.1/github-markdown.min.css"/>
```
`KaTeX` options can be supplied with the second argument to use.
......
package-lock.json
+ 65
− 65
View file @ d5bf730a
{
"name": "markdown-it-katex",
"version": "2.0.3",
"name": "@abreto/markdown-it-katex",
"version": "3.1.0",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
......@@ -10,7 +10,7 @@
"integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==",
"dev": true,
"requires": {
"sprintf-js": "1.0.3"
"sprintf-js": "~1.0.2"
}
},
"assertion-error": {
......@@ -31,7 +31,7 @@
"integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==",
"dev": true,
"requires": {
"balanced-match": "1.0.0",
"balanced-match": "^1.0.0",
"concat-map": "0.0.1"
}
},
......@@ -45,6 +45,11 @@
"deep-eql": "0.1.3"
}
},
"commander": {
"version": "2.20.3",
"resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz",
"integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ=="
},
"concat-map": {
"version": "0.0.1",
"resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
......@@ -72,8 +77,8 @@
"integrity": "sha1-g6c/L+pWmJj7c3GTyPhzyvbUXJQ=",
"dev": true,
"requires": {
"foreach": "2.0.5",
"object-keys": "1.0.11"
"foreach": "^2.0.5",
"object-keys": "^1.0.8"
}
},
"defined": {
......@@ -94,11 +99,11 @@
"integrity": "sha512-/uh/DhdqIOSkAWifU+8nG78vlQxdLckUdI/sPgy0VhuXi2qJ7T8czBmqIYtLQVpCIFYafChnsRsB5pyb1JdmCQ==",
"dev": true,
"requires": {
"es-to-primitive": "1.1.1",
"function-bind": "1.1.1",
"has": "1.0.1",
"is-callable": "1.1.3",
"is-regex": "1.0.4"
"es-to-primitive": "^1.1.1",
"function-bind": "^1.1.1",
"has": "^1.0.1",
"is-callable": "^1.1.3",
"is-regex": "^1.0.4"
}
},
"es-to-primitive": {
......@@ -107,9 +112,9 @@
"integrity": "sha1-RTVSSKiJeQNLZ5Lhm7gfK3l13Q0=",
"dev": true,
"requires": {
"is-callable": "1.1.3",
"is-date-object": "1.0.1",
"is-symbol": "1.0.1"
"is-callable": "^1.1.1",
"is-date-object": "^1.0.1",
"is-symbol": "^1.0.1"
}
},
"esprima": {
......@@ -124,7 +129,7 @@
"integrity": "sha1-LEBFC5NI6X8oEyJZO6lnBLmr1NQ=",
"dev": true,
"requires": {
"is-function": "1.0.1"
"is-function": "~1.0.0"
}
},
"foreach": {
......@@ -151,12 +156,12 @@
"integrity": "sha512-MJTUg1kjuLeQCJ+ccE4Vpa6kKVXkPYJ2mOCQyUuKLcLQsdrMCpBPUi8qVE6+YuaJkozeA9NusTAw3hLr8Xe5EQ==",
"dev": true,
"requires": {
"fs.realpath": "1.0.0",
"inflight": "1.0.6",
"inherits": "2.0.3",
"minimatch": "3.0.4",
"once": "1.4.0",
"path-is-absolute": "1.0.1"
"fs.realpath": "^1.0.0",
"inflight": "^1.0.4",
"inherits": "2",
"minimatch": "^3.0.4",
"once": "^1.3.0",
"path-is-absolute": "^1.0.0"
}
},
"has": {
......@@ -165,7 +170,7 @@
"integrity": "sha1-hGFzP1OLCDfJNh45qauelwTcLyg=",
"dev": true,
"requires": {
"function-bind": "1.1.1"
"function-bind": "^1.0.2"
}
},
"inflight": {
......@@ -174,8 +179,8 @@
"integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=",
"dev": true,
"requires": {
"once": "1.4.0",
"wrappy": "1.0.2"
"once": "^1.3.0",
"wrappy": "1"
}
},
"inherits": {
......@@ -208,7 +213,7 @@
"integrity": "sha1-VRdIm1RwkbCTDglWVM7SXul+lJE=",
"dev": true,
"requires": {
"has": "1.0.1"
"has": "^1.0.1"
}
},
"is-symbol": {
......@@ -223,16 +228,16 @@
"integrity": "sha1-ECeQ8mXZhv6VpNDyp5Lnp72Ibuw=",
"dev": true,
"requires": {
"argparse": "1.0.10",
"esprima": "2.0.0"
"argparse": "~ 1.0.0",
"esprima": "~ 2.0.0"
}
},
"katex": {
"version": "0.10.0",
"resolved": "https://registry.npmjs.org/katex/-/katex-0.10.0.tgz",
"integrity": "sha512-lp3x90LT1tDZBW2tjLheJ98wmRMRjUHwk4QpaswT9bhqoQZ+XA4cPcjcQBxgOQNwaOSt6ZeL/a6GKQ1of3LFxQ==",
"version": "0.11.1",
"resolved": "https://registry.npmjs.org/katex/-/katex-0.11.1.tgz",
"integrity": "sha512-5oANDICCTX0NqYIyAiFCCwjQ7ERu3DQG2JFHLbYOf+fXaMoH8eg/zOq5WSYJsKMi/QebW+Eh3gSM+oss1H/bww==",
"requires": {
"match-at": "0.1.1"
"commander": "^2.19.0"
}
},
"linkify-it": {
......@@ -241,7 +246,7 @@
"integrity": "sha1-2UpGSPmxwXnWT6lykSaL22zpQ08=",
"dev": true,
"requires": {
"uc.micro": "1.0.5"
"uc.micro": "^1.0.1"
}
},
"lodash": {
......@@ -256,11 +261,11 @@
"integrity": "sha512-CzzqSSNkFRUf9vlWvhK1awpJreMRqdCrBvZ8DIoDWTOkESMIF741UPAhuAmbyWmdiFPA6WARNhnu2M6Nrhwa+A==",
"dev": true,
"requires": {
"argparse": "1.0.10",
"entities": "1.1.1",
"linkify-it": "2.0.3",
"mdurl": "1.0.1",
"uc.micro": "1.0.5"
"argparse": "^1.0.7",
"entities": "~1.1.1",
"linkify-it": "^2.0.0",
"mdurl": "^1.0.1",
"uc.micro": "^1.0.5"
}
},
"markdown-it-testgen": {
......@@ -269,16 +274,11 @@
"integrity": "sha1-/NE5ibR2tRP+XUCBGK8JC1S2pGw=",
"dev": true,
"requires": {
"chai": "1.10.0",
"js-yaml": "3.2.7",
"lodash": "2.4.2"
"chai": "~ 1.10.0",
"js-yaml": "~ 3.2.4",
"lodash": "~ 2.4.1"
}
},
"match-at": {
"version": "0.1.1",
"resolved": "https://registry.npmjs.org/match-at/-/match-at-0.1.1.tgz",
"integrity": "sha512-h4Yd392z9mST+dzc+yjuybOGFNOZjmXIPKWjxBd1Bb23r4SmDOsk2NYCU2BMUBGbSpZqwVsZYNq26QS3xfaT3Q=="
},
"mdurl": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz",
......@@ -291,7 +291,7 @@
"integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
"dev": true,
"requires": {
"brace-expansion": "1.1.11"
"brace-expansion": "^1.1.7"
}
},
"minimist": {
......@@ -318,7 +318,7 @@
"integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=",
"dev": true,
"requires": {
"wrappy": "1.0.2"
"wrappy": "1"
}
},
"path-is-absolute": {
......@@ -339,7 +339,7 @@
"integrity": "sha512-hgoSGrc3pjzAPHNBg+KnFcK2HwlHTs/YrAGUr6qgTVUZmXv1UEXXl0bZNBKMA9fud6lRYFdPGz0xXxycPzmmiw==",
"dev": true,
"requires": {
"path-parse": "1.0.5"
"path-parse": "^1.0.5"
}
},
"resumer": {
......@@ -348,7 +348,7 @@
"integrity": "sha1-8ej0YeQGS6Oegq883CqMiT0HZ1k=",
"dev": true,
"requires": {
"through": "2.3.8"
"through": "~2.3.4"
}
},
"sprintf-js": {
......@@ -363,9 +363,9 @@
"integrity": "sha1-0E3iyJ4Tf019IG8Ia17S+ua+jOo=",
"dev": true,
"requires": {
"define-properties": "1.1.2",
"es-abstract": "1.10.0",
"function-bind": "1.1.1"
"define-properties": "^1.1.2",
"es-abstract": "^1.5.0",
"function-bind": "^1.0.2"
}
},
"tape": {
......@@ -374,19 +374,19 @@
"integrity": "sha512-j0jO9BiScfqtPBb9QmPLL0qvxXMz98xjkMb7x8lKipFlJZwNJkqkWPou+NU4V6T9RnVh1kuSthLE8gLrN8bBfw==",
"dev": true,
"requires": {
"deep-equal": "1.0.1",
"defined": "1.0.0",
"for-each": "0.3.2",
"function-bind": "1.1.1",
"glob": "7.1.2",
"has": "1.0.1",
"inherits": "2.0.3",
"minimist": "1.2.0",
"object-inspect": "1.5.0",
"resolve": "1.5.0",
"resumer": "0.0.0",
"string.prototype.trim": "1.1.2",
"through": "2.3.8"
"deep-equal": "~1.0.1",
"defined": "~1.0.0",
"for-each": "~0.3.2",
"function-bind": "~1.1.1",
"glob": "~7.1.2",
"has": "~1.0.1",
"inherits": "~2.0.3",
"minimist": "~1.2.0",
"object-inspect": "~1.5.0",
"resolve": "~1.5.0",
"resumer": "~0.0.0",
"string.prototype.trim": "~1.1.2",
"through": "~2.3.8"
}
},
"through": {
......
package.json
+ 5
− 5
View file @ d5bf730a
{
"name": "@iktakahiro/markdown-it-katex",
"version": "3.1.0",
"name": "@abreto/markdown-it-katex",
"version": "3.2.0",
"description": "Fast math support for markdown-it with KaTeX",
"main": "index.js",
"scripts": {
......@@ -9,7 +9,7 @@
},
"repository": {
"type": "git",
"url": "git+ssh://git@github.com:iktakahiro/markdown-it-katex.git"
"url": "git+ssh://git@github.com:Abreto/markdown-it-katex.git"
},
"keywords": [
"markdown",
......@@ -19,10 +19,10 @@
"markdown-it-plugin",
"markdown-it"
],
"author": "Takahiro Ethan Ikeuchi @iktakahiro",
"author": "Abreto Fu",
"license": "MIT",
"dependencies": {
"katex": "^0.10.0"
"katex": "^0.11.1"
},
"devDependencies": {
"markdown-it": "^8.4.1",
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment