218 changed files with 20241 additions and 38 deletions
@ -0,0 +1,28 @@
|
||||
# Logs |
||||
logs |
||||
*.log |
||||
|
||||
# Runtime data |
||||
pids |
||||
*.pid |
||||
*.seed |
||||
|
||||
# Directory for instrumented libs generated by jscoverage/JSCover |
||||
lib-cov |
||||
|
||||
# Coverage directory used by tools like istanbul |
||||
coverage |
||||
|
||||
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) |
||||
.grunt |
||||
|
||||
# Compiled binary addons (http://nodejs.org/api/addons.html) |
||||
build/Release |
||||
|
||||
# Dependency directory |
||||
# Commenting this out is preferred by some people, see |
||||
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git- |
||||
node_modules |
||||
|
||||
# Users Environment Variables |
||||
.lock-wscript |
||||
@ -0,0 +1,201 @@
|
||||
Apache License |
||||
Version 2.0, January 2004 |
||||
http://www.apache.org/licenses/ |
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION |
||||
|
||||
1. Definitions. |
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction, |
||||
and distribution as defined by Sections 1 through 9 of this document. |
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by |
||||
the copyright owner that is granting the License. |
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all |
||||
other entities that control, are controlled by, or are under common |
||||
control with that entity. For the purposes of this definition, |
||||
"control" means (i) the power, direct or indirect, to cause the |
||||
direction or management of such entity, whether by contract or |
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the |
||||
outstanding shares, or (iii) beneficial ownership of such entity. |
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity |
||||
exercising permissions granted by this License. |
||||
|
||||
"Source" form shall mean the preferred form for making modifications, |
||||
including but not limited to software source code, documentation |
||||
source, and configuration files. |
||||
|
||||
"Object" form shall mean any form resulting from mechanical |
||||
transformation or translation of a Source form, including but |
||||
not limited to compiled object code, generated documentation, |
||||
and conversions to other media types. |
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or |
||||
Object form, made available under the License, as indicated by a |
||||
copyright notice that is included in or attached to the work |
||||
(an example is provided in the Appendix below). |
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object |
||||
form, that is based on (or derived from) the Work and for which the |
||||
editorial revisions, annotations, elaborations, or other modifications |
||||
represent, as a whole, an original work of authorship. For the purposes |
||||
of this License, Derivative Works shall not include works that remain |
||||
separable from, or merely link (or bind by name) to the interfaces of, |
||||
the Work and Derivative Works thereof. |
||||
|
||||
"Contribution" shall mean any work of authorship, including |
||||
the original version of the Work and any modifications or additions |
||||
to that Work or Derivative Works thereof, that is intentionally |
||||
submitted to Licensor for inclusion in the Work by the copyright owner |
||||
or by an individual or Legal Entity authorized to submit on behalf of |
||||
the copyright owner. For the purposes of this definition, "submitted" |
||||
means any form of electronic, verbal, or written communication sent |
||||
to the Licensor or its representatives, including but not limited to |
||||
communication on electronic mailing lists, source code control systems, |
||||
and issue tracking systems that are managed by, or on behalf of, the |
||||
Licensor for the purpose of discussing and improving the Work, but |
||||
excluding communication that is conspicuously marked or otherwise |
||||
designated in writing by the copyright owner as "Not a Contribution." |
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity |
||||
on behalf of whom a Contribution has been received by Licensor and |
||||
subsequently incorporated within the Work. |
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of |
||||
this License, each Contributor hereby grants to You a perpetual, |
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
||||
copyright license to reproduce, prepare Derivative Works of, |
||||
publicly display, publicly perform, sublicense, and distribute the |
||||
Work and such Derivative Works in Source or Object form. |
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of |
||||
this License, each Contributor hereby grants to You a perpetual, |
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
||||
(except as stated in this section) patent license to make, have made, |
||||
use, offer to sell, sell, import, and otherwise transfer the Work, |
||||
where such license applies only to those patent claims licensable |
||||
by such Contributor that are necessarily infringed by their |
||||
Contribution(s) alone or by combination of their Contribution(s) |
||||
with the Work to which such Contribution(s) was submitted. If You |
||||
institute patent litigation against any entity (including a |
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work |
||||
or a Contribution incorporated within the Work constitutes direct |
||||
or contributory patent infringement, then any patent licenses |
||||
granted to You under this License for that Work shall terminate |
||||
as of the date such litigation is filed. |
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the |
||||
Work or Derivative Works thereof in any medium, with or without |
||||
modifications, and in Source or Object form, provided that You |
||||
meet the following conditions: |
||||
|
||||
(a) You must give any other recipients of the Work or |
||||
Derivative Works a copy of this License; and |
||||
|
||||
(b) You must cause any modified files to carry prominent notices |
||||
stating that You changed the files; and |
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works |
||||
that You distribute, all copyright, patent, trademark, and |
||||
attribution notices from the Source form of the Work, |
||||
excluding those notices that do not pertain to any part of |
||||
the Derivative Works; and |
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its |
||||
distribution, then any Derivative Works that You distribute must |
||||
include a readable copy of the attribution notices contained |
||||
within such NOTICE file, excluding those notices that do not |
||||
pertain to any part of the Derivative Works, in at least one |
||||
of the following places: within a NOTICE text file distributed |
||||
as part of the Derivative Works; within the Source form or |
||||
documentation, if provided along with the Derivative Works; or, |
||||
within a display generated by the Derivative Works, if and |
||||
wherever such third-party notices normally appear. The contents |
||||
of the NOTICE file are for informational purposes only and |
||||
do not modify the License. You may add Your own attribution |
||||
notices within Derivative Works that You distribute, alongside |
||||
or as an addendum to the NOTICE text from the Work, provided |
||||
that such additional attribution notices cannot be construed |
||||
as modifying the License. |
||||
|
||||
You may add Your own copyright statement to Your modifications and |
||||
may provide additional or different license terms and conditions |
||||
for use, reproduction, or distribution of Your modifications, or |
||||
for any such Derivative Works as a whole, provided Your use, |
||||
reproduction, and distribution of the Work otherwise complies with |
||||
the conditions stated in this License. |
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise, |
||||
any Contribution intentionally submitted for inclusion in the Work |
||||
by You to the Licensor shall be under the terms and conditions of |
||||
this License, without any additional terms or conditions. |
||||
Notwithstanding the above, nothing herein shall supersede or modify |
||||
the terms of any separate license agreement you may have executed |
||||
with Licensor regarding such Contributions. |
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade |
||||
names, trademarks, service marks, or product names of the Licensor, |
||||
except as required for reasonable and customary use in describing the |
||||
origin of the Work and reproducing the content of the NOTICE file. |
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or |
||||
agreed to in writing, Licensor provides the Work (and each |
||||
Contributor provides its Contributions) on an "AS IS" BASIS, |
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
||||
implied, including, without limitation, any warranties or conditions |
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A |
||||
PARTICULAR PURPOSE. You are solely responsible for determining the |
||||
appropriateness of using or redistributing the Work and assume any |
||||
risks associated with Your exercise of permissions under this License. |
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory, |
||||
whether in tort (including negligence), contract, or otherwise, |
||||
unless required by applicable law (such as deliberate and grossly |
||||
negligent acts) or agreed to in writing, shall any Contributor be |
||||
liable to You for damages, including any direct, indirect, special, |
||||
incidental, or consequential damages of any character arising as a |
||||
result of this License or out of the use or inability to use the |
||||
Work (including but not limited to damages for loss of goodwill, |
||||
work stoppage, computer failure or malfunction, or any and all |
||||
other commercial damages or losses), even if such Contributor |
||||
has been advised of the possibility of such damages. |
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing |
||||
the Work or Derivative Works thereof, You may choose to offer, |
||||
and charge a fee for, acceptance of support, warranty, indemnity, |
||||
or other liability obligations and/or rights consistent with this |
||||
License. However, in accepting such obligations, You may act only |
||||
on Your own behalf and on Your sole responsibility, not on behalf |
||||
of any other Contributor, and only if You agree to indemnify, |
||||
defend, and hold each Contributor harmless for any liability |
||||
incurred by, or claims asserted against, such Contributor by reason |
||||
of your accepting any such warranty or additional liability. |
||||
|
||||
END OF TERMS AND CONDITIONS |
||||
|
||||
APPENDIX: How to apply the Apache License to your work. |
||||
|
||||
To apply the Apache License to your work, attach the following |
||||
boilerplate notice, with the fields enclosed by brackets "{}" |
||||
replaced with your own identifying information. (Don't include |
||||
the brackets!) The text should be enclosed in the appropriate |
||||
comment syntax for the file format. We also recommend that a |
||||
file or class name and description of purpose be included on the |
||||
same "printed page" as the copyright notice for easier |
||||
identification within third-party archives. |
||||
|
||||
Copyright {yyyy} {name of copyright owner} |
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License"); |
||||
you may not use this file except in compliance with the License. |
||||
You may obtain a copy of the License at |
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0 |
||||
|
||||
Unless required by applicable law or agreed to in writing, software |
||||
distributed under the License is distributed on an "AS IS" BASIS, |
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
See the License for the specific language governing permissions and |
||||
limitations under the License. |
||||
@ -0,0 +1,35 @@
|
||||
Math typesetting using KaTex |
||||
============== |
||||
|
||||
Use it for your book, by adding to your book.json: |
||||
|
||||
``` |
||||
{ |
||||
"plugins": ["katex"] |
||||
} |
||||
``` |
||||
|
||||
then run `gitbook install`. |
||||
|
||||
## Usage |
||||
|
||||
``` |
||||
Inline math: $$\int_{-\infty}^\infty g(x) dx$$ |
||||
|
||||
|
||||
Block math: |
||||
|
||||
$$ |
||||
\int_{-\infty}^\infty g(x) dx |
||||
$$ |
||||
|
||||
Or using the templating syntax: |
||||
|
||||
{% math %}\int_{-\infty}^\infty g(x) dx{% endblock %} |
||||
``` |
||||
|
||||
|
||||
### Comparison with [MathJax](https://github.com/GitbookIO/plugin-mathjax) |
||||
|
||||
- Faster |
||||
|
||||
@ -0,0 +1,35 @@
|
||||
var katex = require("katex"); |
||||
|
||||
module.exports = { |
||||
book: { |
||||
assets: "./static", |
||||
js: [], |
||||
css: [ |
||||
"katex.min.css" |
||||
] |
||||
}, |
||||
ebook: { |
||||
assets: "./static", |
||||
css: [ |
||||
"katex.min.css" |
||||
] |
||||
}, |
||||
blocks: { |
||||
math: { |
||||
shortcuts: { |
||||
parsers: ["markdown", "asciidoc", "restructuredtext"], |
||||
start: "$$", |
||||
end: "$$" |
||||
}, |
||||
process: function(blk) { |
||||
var tex = blk.body; |
||||
var isInline = !(tex[0] == "\n"); |
||||
var output = katex.renderToString(tex, { |
||||
displayMode: !isInline |
||||
}); |
||||
|
||||
return output; |
||||
} |
||||
} |
||||
} |
||||
}; |
||||
@ -0,0 +1,106 @@
|
||||
{ |
||||
"_args": [ |
||||
[ |
||||
{ |
||||
"name": "gitbook-plugin-katex", |
||||
"raw": "gitbook-plugin-katex@1.1.4", |
||||
"rawSpec": "1.1.4", |
||||
"scope": null, |
||||
"spec": "1.1.4", |
||||
"type": "version" |
||||
}, |
||||
"/Volumes/Atelier/lucil/Documents/_WEB/StreamMusicalPerformance" |
||||
] |
||||
], |
||||
"_from": "gitbook-plugin-katex@1.1.4", |
||||
"_id": "gitbook-plugin-katex@1.1.4", |
||||
"_inCache": true, |
||||
"_installable": true, |
||||
"_location": "/gitbook-plugin-katex", |
||||
"_nodeVersion": "8.1.3", |
||||
"_npmOperationalInternal": { |
||||
"host": "s3://npm-registry-packages", |
||||
"tmp": "tmp/gitbook-plugin-katex-1.1.4.tgz_1502894343416_0.2687492223922163" |
||||
}, |
||||
"_npmUser": { |
||||
"email": "aaron.omullan@gmail.com", |
||||
"name": "aarono" |
||||
}, |
||||
"_npmVersion": "5.0.3", |
||||
"_phantomChildren": {}, |
||||
"_requested": { |
||||
"name": "gitbook-plugin-katex", |
||||
"raw": "gitbook-plugin-katex@1.1.4", |
||||
"rawSpec": "1.1.4", |
||||
"scope": null, |
||||
"spec": "1.1.4", |
||||
"type": "version" |
||||
}, |
||||
"_requiredBy": [ |
||||
"#USER" |
||||
], |
||||
"_resolved": "https://registry.npmjs.org/gitbook-plugin-katex/-/gitbook-plugin-katex-1.1.4.tgz", |
||||
"_shasum": "9d323efadd26c3408526c5c227ebdb4c1120d9ac", |
||||
"_shrinkwrap": null, |
||||
"_spec": "gitbook-plugin-katex@1.1.4", |
||||
"_where": "/Volumes/Atelier/lucil/Documents/_WEB/StreamMusicalPerformance", |
||||
"bugs": { |
||||
"url": "https://github.com/GitbookIO/plugin-katex/issues" |
||||
}, |
||||
"dependencies": { |
||||
"katex": "0.7.1" |
||||
}, |
||||
"description": "Math typesetting using KaTex into GitBook", |
||||
"devDependencies": {}, |
||||
"directories": {}, |
||||
"dist": { |
||||
"integrity": "sha512-eBDcI3Cq2ZJFTbqYu313pg+Xkmf7q8bQLKNJMj0ADFYJKGOFSKf5MvY3TscKDYp57eq/BcUfnH43VX9mdsqo8g==", |
||||
"shasum": "9d323efadd26c3408526c5c227ebdb4c1120d9ac", |
||||
"tarball": "https://registry.npmjs.org/gitbook-plugin-katex/-/gitbook-plugin-katex-1.1.4.tgz" |
||||
}, |
||||
"engines": { |
||||
"gitbook": ">=2.0.0" |
||||
}, |
||||
"gitHead": "85a5f11e6f400705b125bec87909b2ec6efb2822", |
||||
"homepage": "https://github.com/GitbookIO/plugin-katex", |
||||
"keywords": [ |
||||
"math", |
||||
"latex" |
||||
], |
||||
"license": "Apache-2.0", |
||||
"main": "index.js", |
||||
"maintainers": [ |
||||
{ |
||||
"email": "samypesse@gmail.com", |
||||
"name": "samypesse" |
||||
}, |
||||
{ |
||||
"email": "hello@gabinaureche.com", |
||||
"name": "zhouzi" |
||||
}, |
||||
{ |
||||
"email": "soreine.plume@gmail.com", |
||||
"name": "soreine" |
||||
}, |
||||
{ |
||||
"email": "johan.preynat@gmail.com", |
||||
"name": "jpreynat" |
||||
}, |
||||
{ |
||||
"email": "aaron.omullan@gmail.com", |
||||
"name": "aarono" |
||||
}, |
||||
{ |
||||
"email": "contact@gitbook.com", |
||||
"name": "gitbook-bot" |
||||
} |
||||
], |
||||
"name": "gitbook-plugin-katex", |
||||
"optionalDependencies": {}, |
||||
"readme": "ERROR: No README data found!", |
||||
"repository": { |
||||
"type": "git", |
||||
"url": "git+https://github.com/GitbookIO/plugin-katex.git" |
||||
}, |
||||
"version": "1.1.4" |
||||
} |
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File diff suppressed because one or more lines are too long
@ -0,0 +1,27 @@
|
||||
The MIT License (MIT) |
||||
|
||||
Copyright (c) 2015 Khan Academy |
||||
|
||||
This software also uses portions of the underscore.js project, which is |
||||
MIT licensed with the following copyright: |
||||
|
||||
Copyright (c) 2009-2015 Jeremy Ashkenas, DocumentCloud and Investigative |
||||
Reporters & Editors |
||||
|
||||
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. |
||||
@ -0,0 +1,68 @@
|
||||
# [<img src="https://khan.github.io/KaTeX/katex-logo.svg" width="130" alt="KaTeX">](https://khan.github.io/KaTeX/) [](https://travis-ci.org/Khan/KaTeX) |
||||
|
||||
[](https://gitter.im/Khan/KaTeX?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
||||
|
||||
KaTeX is a fast, easy-to-use JavaScript library for TeX math rendering on the web. |
||||
|
||||
* **Fast:** KaTeX renders its math synchronously and doesn't need to reflow the page. See how it compares to a competitor in [this speed test](http://jsperf.com/katex-vs-mathjax/). |
||||
* **Print quality:** KaTeX’s layout is based on Donald Knuth’s TeX, the gold standard for math typesetting. |
||||
* **Self contained:** KaTeX has no dependencies and can easily be bundled with your website resources. |
||||
* **Server side rendering:** KaTeX produces the same output regardless of browser or environment, so you can pre-render expressions using Node.js and send them as plain HTML. |
||||
|
||||
KaTeX supports all major browsers, including Chrome, Safari, Firefox, Opera, and IE 8 - IE 11. A list of supported commands can be on the [wiki](https://github.com/Khan/KaTeX/wiki/Function-Support-in-KaTeX). |
||||
|
||||
## Usage |
||||
|
||||
You can [download KaTeX](https://github.com/khan/katex/releases) and host it on your server or include the `katex.min.js` and `katex.min.css` files on your page directly from a CDN: |
||||
|
||||
```html |
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.7.1/katex.min.css"> |
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.7.1/katex.min.js"></script> |
||||
``` |
||||
|
||||
#### In-browser rendering |
||||
|
||||
Call `katex.render` with a TeX expression and a DOM element to render into: |
||||
|
||||
```js |
||||
katex.render("c = \\pm\\sqrt{a^2 + b^2}", element); |
||||
``` |
||||
|
||||
If KaTeX can't parse the expression, it throws a `katex.ParseError` error. |
||||
|
||||
#### Server side rendering or rendering to a string |
||||
|
||||
To generate HTML on the server or to generate an HTML string of the rendered math, you can use `katex.renderToString`: |
||||
|
||||
```js |
||||
var html = katex.renderToString("c = \\pm\\sqrt{a^2 + b^2}"); |
||||
// '<span class="katex">...</span>' |
||||
``` |
||||
|
||||
Make sure to include the CSS and font files, but there is no need to include the JavaScript. Like `render`, `renderToString` throws if it can't parse the expression. |
||||
|
||||
#### Rendering options |
||||
|
||||
You can provide an object of options as the last argument to `katex.render` and `katex.renderToString`. Available options are: |
||||
|
||||
- `displayMode`: `boolean`. If `true` the math will be rendered in display mode, which will put the math in display style (so `\int` and `\sum` are large, for example), and will center the math on the page on its own line. If `false` the math will be rendered in inline mode. (default: `false`) |
||||
- `throwOnError`: `boolean`. If `true`, KaTeX will throw a `ParseError` when it encounters an unsupported command. If `false`, KaTeX will render the unsupported command as text in the color given by `errorColor`. (default: `true`) |
||||
- `errorColor`: `string`. A color string given in the format `"#XXX"` or `"#XXXXXX"`. This option determines the color which unsupported commands are rendered in. (default: `#cc0000`) |
||||
|
||||
For example: |
||||
|
||||
```js |
||||
katex.render("c = \\pm\\sqrt{a^2 + b^2}", element, { displayMode: true }); |
||||
``` |
||||
|
||||
#### Automatic rendering of math on a page |
||||
|
||||
Math on the page can be automatically rendered using the auto-render extension. See [the Auto-render README](contrib/auto-render/README.md) for more information. |
||||
|
||||
## Contributing |
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) |
||||
|
||||
## License |
||||
|
||||
KaTeX is licensed under the [MIT License](http://opensource.org/licenses/MIT). |
||||
@ -0,0 +1,32 @@
|
||||
#!/usr/bin/env node
|
||||
// Simple CLI for KaTeX.
|
||||
// Reads TeX from stdin, outputs HTML to stdout.
|
||||
/* eslint no-console:0 */ |
||||
|
||||
var katex = require("./"); |
||||
var input = ""; |
||||
|
||||
// Skip the first two args, which are just "node" and "cli.js"
|
||||
var args = process.argv.slice(2); |
||||
|
||||
if (args.indexOf("--help") !== -1) { |
||||
console.log(process.argv[0] + " " + process.argv[1] + |
||||
" [ --help ]" + |
||||
" [ --display-mode ]"); |
||||
|
||||
console.log("\n" + |
||||
"Options:"); |
||||
console.log(" --help Display this help message"); |
||||
console.log(" --display-mode Render in display mode (not inline mode)"); |
||||
process.exit(); |
||||
} |
||||
|
||||
process.stdin.on("data", function(chunk) { |
||||
input += chunk.toString(); |
||||
}); |
||||
|
||||
process.stdin.on("end", function() { |
||||
var options = { displayMode: args.indexOf("--display-mode") !== -1 }; |
||||
var output = katex.renderToString(input, options); |
||||
console.log(output); |
||||
}); |
||||
@ -0,0 +1,68 @@
|
||||
# [<img src="https://khan.github.io/KaTeX/katex-logo.svg" width="130" alt="KaTeX">](https://khan.github.io/KaTeX/) [](https://travis-ci.org/Khan/KaTeX) |
||||
|
||||
[](https://gitter.im/Khan/KaTeX?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
||||
|
||||
KaTeX is a fast, easy-to-use JavaScript library for TeX math rendering on the web. |
||||
|
||||
* **Fast:** KaTeX renders its math synchronously and doesn't need to reflow the page. See how it compares to a competitor in [this speed test](http://jsperf.com/katex-vs-mathjax/). |
||||
* **Print quality:** KaTeX’s layout is based on Donald Knuth’s TeX, the gold standard for math typesetting. |
||||
* **Self contained:** KaTeX has no dependencies and can easily be bundled with your website resources. |
||||
* **Server side rendering:** KaTeX produces the same output regardless of browser or environment, so you can pre-render expressions using Node.js and send them as plain HTML. |
||||
|
||||
KaTeX supports all major browsers, including Chrome, Safari, Firefox, Opera, and IE 8 - IE 11. A list of supported commands can be on the [wiki](https://github.com/Khan/KaTeX/wiki/Function-Support-in-KaTeX). |
||||
|
||||
## Usage |
||||
|
||||
You can [download KaTeX](https://github.com/khan/katex/releases) and host it on your server or include the `katex.min.js` and `katex.min.css` files on your page directly from a CDN: |
||||
|
||||
```html |
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.7.1/katex.min.css"> |
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.7.1/katex.min.js"></script> |
||||
``` |
||||
|
||||
#### In-browser rendering |
||||
|
||||
Call `katex.render` with a TeX expression and a DOM element to render into: |
||||
|
||||
```js |
||||
katex.render("c = \\pm\\sqrt{a^2 + b^2}", element); |
||||
``` |
||||
|
||||
If KaTeX can't parse the expression, it throws a `katex.ParseError` error. |
||||
|
||||
#### Server side rendering or rendering to a string |
||||
|
||||
To generate HTML on the server or to generate an HTML string of the rendered math, you can use `katex.renderToString`: |
||||
|
||||
```js |
||||
var html = katex.renderToString("c = \\pm\\sqrt{a^2 + b^2}"); |
||||
// '<span class="katex">...</span>' |
||||
``` |
||||
|
||||
Make sure to include the CSS and font files, but there is no need to include the JavaScript. Like `render`, `renderToString` throws if it can't parse the expression. |
||||
|
||||
#### Rendering options |
||||
|
||||
You can provide an object of options as the last argument to `katex.render` and `katex.renderToString`. Available options are: |
||||
|
||||
- `displayMode`: `boolean`. If `true` the math will be rendered in display mode, which will put the math in display style (so `\int` and `\sum` are large, for example), and will center the math on the page on its own line. If `false` the math will be rendered in inline mode. (default: `false`) |
||||
- `throwOnError`: `boolean`. If `true`, KaTeX will throw a `ParseError` when it encounters an unsupported command. If `false`, KaTeX will render the unsupported command as text in the color given by `errorColor`. (default: `true`) |
||||
- `errorColor`: `string`. A color string given in the format `"#XXX"` or `"#XXXXXX"`. This option determines the color which unsupported commands are rendered in. (default: `#cc0000`) |
||||
|
||||
For example: |
||||
|
||||
```js |
||||
katex.render("c = \\pm\\sqrt{a^2 + b^2}", element, { displayMode: true }); |
||||
``` |
||||
|
||||
#### Automatic rendering of math on a page |
||||
|
||||
Math on the page can be automatically rendered using the auto-render extension. See [the Auto-render README](contrib/auto-render/README.md) for more information. |
||||
|
||||
## Contributing |
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) |
||||
|
||||
## License |
||||
|
||||
KaTeX is licensed under the [MIT License](http://opensource.org/licenses/MIT). |
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue