diff --git a/CHANGELOG.md b/CHANGELOG.md index f1740d15..ccbf35ff 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,11 +1,11 @@ -# Change Log +# Changelog All notable changes to this project will be documented in this file. This CHANGELOG roughly follows the guidelines from [www.keepachangelog.com](https://keepachangelog.com/en/1.0.0/). -## [v0.10.0] - RC +## [v0.10.0] ### Added -- Unicode: °, delimiters, 1D400-1D7FF, \ll, \lll, ≘≙≚≛≝≞≟, Unicode Mathematical Alphanumeric Symbols, ⟂ ¬ ⊨ ‼ ∌ ≲ ⩽ ⪅ ≶ ⋚ ⪋, corner (#1203, #1207, #1260, #1273, #1274, #1232, #1377, #1389, #1459) +- Unicode: °, delimiters, 1D400-1D7FF, \ll, \lll, ≘≙≚≛≝≞≟, Unicode Mathematical Alphanumeric Symbols, ⟂ ¬ ⊨ ‼ ∌ ≲ ⩽ ⪅ ≶ ⋚ ⪋, corner, ⟦⟧ (#1203, #1207, #1260, #1273, #1274, #1232, #1377, #1389, #1459, #1750) - \yen support on text mode (#1208) -- \( (#1213) +- `\(` (#1213) - Add defineSymbol to the main katex object (#1263) - Capital Greek letters (#1283, #1285) - Add version to katex object (#1279, #1475) @@ -13,7 +13,7 @@ All notable changes to this project will be documented in this file. This CHANGE - Tilde \textasciitilde (#1286) - Line breaks for inline formulas (#1287) - \hline (#1306) -- Top-level \newline and \\ in inline math (#1298) +- Top-level \newline and `\\` in inline math (#1298) - Strict mode, unicode text in math mode (#1117, #1278) - Strict setting for \newline display-mode behavior (#1314) - Allow all Unicode symbols in nonstrict mode (#1217) @@ -31,39 +31,48 @@ All notable changes to this project will be documented in this file. This CHANGE - Remove `match-at` dependency, use RegExp for lexer (#1447) - \brace and \brack (#1453) - Allow only allowed protocols in \href (#1440) + - **BREAKING CHANGE:** Only "http", "https", "mailto", and relative URLs are allowed in \href and \url by default. - \genfrac and \above (#1455, #1458) - \char character escaping and nicer MathML via \html@mathml (#1454) - \@binrel (#1487) - \pmb (#1418) -- KaTeX website & documentation (#1484, #1515, #1518, #1514, #1526, #1516, #1519, #1527, #1564, #1566, #1584) +- KaTeX website & documentation (#1484, #1515, #1518, #1514, #1526, #1516, #1519, #1527, #1564, #1566, #1584, #1571, #1642, #1680, #1683, #1688, #1631, #1727) - Improve supported functions documentation (#1511, #1517, #1532, #1533, #1576, #1556, #1580, #1602) - Alpha sorted function support page (#1536) - MediaWiki (texvc) (#1558) - Add ignore option for class names in auto-render (#1555) - ScrollSpy for table of contents in the documentation (#1557, #1567, #1568) -- Build ECMAScript modules (#1479, #1622) +- Build ECMAScript modules (#1479, #1622, #1653) - Enable environment variable USE_TTF to disable bundling TTF fonts (#1600) - List of KaTeX users (#1569, #1579) +- Browserslist (#1662) +- 6-digit color without # (#1690) +- \mathnormal (#1700) +- \lparen and \rparen (#1741) +- `\>` (#1752) ### Changed -- Port to @flow: delimiter, spacingData, unicodeSymbols, buildHTML, buildMathML, parseNode, defineFunction (#1177, #1195, #1206, #1239, #1247, #1276, #1312, #1324, #1361, #1373, #1393, #1386, #1387, #1408, #1478, #1486, #1534, #1541, #1542, #1551, #1552, #1554, #1559, #1606, #1609, #1612, #1637) +- Port to @flow: delimiter, spacingData, unicodeSymbols, buildHTML, buildMathML, parseNode, defineFunction, CssStyle (#1177, #1195, #1206, #1239, #1247, #1276, #1312, #1324, #1361, #1373, #1393, #1386, #1387, #1408, #1478, #1486, #1534, #1541, #1542, #1551, #1552, #1554, #1559, #1606, #1609, #1612, #1637, #1684) - Online screenshot diff/generation using CircleCI (#1187) - Add display/displayMode toggle on test page (#1193) - Change CDN links (#1243) - Changelog for KaTeX (#1322) - Move test helpers into common modules (#1318) - Move function handlers to functions/ (#1323, #1325, #1328, #1329, #1331, #1327, #1334, #1339, #1349, #1359, #1332, #1335) -- Add regenerate option to the screenshotter (#1220) +- Improve screenshotter (#1220, #1644, #1643) - Upgrade to webpack 4 (#1337, #1435) - Automatic submodule updating via husky tool (#1391) - Refactor test helpers (#1336) - Change build directory to `dist` and cleanup NPM scripts (#1500, #1610) - Switch from nomnom to commander (#1496) -- Add test job to CircleCI (#1235) +- Add test job to CircleCI (#1235, #1658) - Switch npm to Yarn (#1522, #1528) -- Improve release script & enable versioning documentation (#1521, #1603) +- Improve release script & enable versioning documentation (#1521, #1603, #1660, #1665) - Enable stylelint-config-standard, lint CSS files (#1575) - Rename Screenshotter -> screenshotter (#1573) +- Refactor buildCommon (#1633, #1640) +- Upgrade to Babel 7 (#1595) +- Refactor Parser (#1711, #1723) ### Fixed - Fix nested math mode in non-default text mode (#1111) @@ -87,7 +96,7 @@ All notable changes to this project will be documented in this file. This CHANGE - Fix vertical alignment of \underbrace (#1304) - Use one strut instead of two (#1307) - Fix MacroExpander space handling (#1314) -- Cleanup MathML , , (#1338) +- Cleanup MathML ``, ``, `` (#1338) - Fix lap vertical alignment. (#1162) - Fix nested \tfrac (#1370) - Fix \coloneq etc (#1372) @@ -116,6 +125,9 @@ All notable changes to this project will be documented in this file. This CHANGE - Fix \fbox (#1550) - Fix \Large roots (#1485) - index.html: replace font, make responsive, improve demo (#1547, #1577, #1615, #1601) +- Remove duplicate defineFunction invocation for \mathop (#1701) +- Fix tag positioning to live within katex-html parent (#1721) +- Fix \mathit font and italic correction (#1700) ## [v0.9.0] - 2018-02-18 diff --git a/README.md b/README.md index e6d9fefe..2c0c7a4c 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![codecov](https://codecov.io/gh/Khan/KaTeX/branch/master/graph/badge.svg)](https://codecov.io/gh/Khan/KaTeX) [![Join the chat at https://gitter.im/Khan/KaTeX](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Khan/KaTeX?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Greenkeeper badge](https://badges.greenkeeper.io/Khan/KaTeX.svg)](https://greenkeeper.io/) [![jsDelivr](https://data.jsdelivr.com/v1/package/npm/katex/badge?style=rounded)](https://www.jsdelivr.com/package/npm/katex) -![](https://img.badgesize.io/Khan/KaTeX/v0.10.0-rc.1/dist/katex.min.js?compression=gzip) +![](https://img.badgesize.io/Khan/KaTeX/v0.10.0/dist/katex.min.js?compression=gzip) KaTeX is a fast, easy-to-use JavaScript library for TeX math rendering on the web. @@ -28,13 +28,13 @@ Try out KaTeX [on the demo page](https://katex.org/#demo)! - + - + - ... diff --git a/contrib/copy-tex/README.md b/contrib/copy-tex/README.md index 80c527f0..4e63c68a 100644 --- a/contrib/copy-tex/README.md +++ b/contrib/copy-tex/README.md @@ -21,8 +21,8 @@ provided by this extension). Without this CSS, partially selected equations will just get the usual HTML copy/paste behavior. ```html - - + + ``` See [index.html](index.html) for an example. diff --git a/contrib/mathtex-script-type/README.md b/contrib/mathtex-script-type/README.md index fe7ab5d0..22fb4cd5 100644 --- a/contrib/mathtex-script-type/README.md +++ b/contrib/mathtex-script-type/README.md @@ -12,7 +12,7 @@ Load the extension by adding the following line to your HTML file. This extension should be loaded *after* all `script type=math/tex` blocks that you want to render. ```html - + ``` Note that if the URL above contains `...` in-place of a version string, then this script has not yet been deployed to the CDN. @@ -25,12 +25,12 @@ After we're done writing `math/tex` scripts, we load this extension. ```html - - + + - + ``` diff --git a/docs/autorender.md b/docs/autorender.md index 4090985f..077e63ce 100644 --- a/docs/autorender.md +++ b/docs/autorender.md @@ -12,9 +12,9 @@ This extension isn't part of KaTeX proper, so the script needs to be included using a CDN: ```html - - - + ``` @@ -31,9 +31,9 @@ want to use a `defer` or `onload` attribute. For example: ```html - - - + + + + + ``` KaTeX also provides minified versions: ```html - - + + ``` > The loading of scripts are [deferred using `defer` attribute](https://developer.mozilla.org/en/HTML/Element/script#Attributes) @@ -40,11 +40,11 @@ ECMAScript module is also available: ```html - - + + ``` > Use [`nomodule` attribute](https://developer.mozilla.org/en/HTML/Element/script#Attributes) diff --git a/package.json b/package.json index 0957001e..c728dca9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "katex", - "version": "0.10.0-pre", + "version": "0.10.1-pre", "description": "Fast math typesetting for the web.", "main": "dist/katex.js", "repository": { diff --git a/update-sri.js b/update-sri.js index 0d74b359..f61a54c9 100644 --- a/update-sri.js +++ b/update-sri.js @@ -36,7 +36,8 @@ Promise.all(process.argv.slice(3).map(file => const newHash = sriToolbox.generate({ algorithms: [hashes[hash].algo], }, data); - body = body.replace(hash, newHash); + body = body.replace( + new RegExp(hash.replace(/\+/g, '\\+'), 'g'), newHash); if (version === "check" && hash !== newHash) { throw new Error("SRI mismatch! " + diff --git a/website/package.json b/website/package.json index 5675c5fc..26b8683b 100644 --- a/website/package.json +++ b/website/package.json @@ -7,7 +7,7 @@ "rename-version": "docusaurus-rename-version" }, "devDependencies": { - "docusaurus": "^1.3.3", + "docusaurus": "^1.5.0", "fs-extra": "^7.0.0" }, "dependencies": {} diff --git a/website/versioned_docs/version-0.10.0-rc.1/api.md b/website/versioned_docs/version-0.10.0/api.md similarity index 97% rename from website/versioned_docs/version-0.10.0-rc.1/api.md rename to website/versioned_docs/version-0.10.0/api.md index 9e835267..9636905e 100644 --- a/website/versioned_docs/version-0.10.0-rc.1/api.md +++ b/website/versioned_docs/version-0.10.0/api.md @@ -1,5 +1,5 @@ --- -id: version-0.10.0-rc.1-api +id: version-0.10.0-api title: API original_id: api --- diff --git a/website/versioned_docs/version-0.10.0-rc.1/autorender.md b/website/versioned_docs/version-0.10.0/autorender.md similarity index 74% rename from website/versioned_docs/version-0.10.0-rc.1/autorender.md rename to website/versioned_docs/version-0.10.0/autorender.md index 2882f842..1332c59f 100644 --- a/website/versioned_docs/version-0.10.0-rc.1/autorender.md +++ b/website/versioned_docs/version-0.10.0/autorender.md @@ -1,5 +1,5 @@ --- -id: version-0.10.0-rc.1-autorender +id: version-0.10.0-autorender title: Auto-render Extension original_id: autorender --- @@ -13,9 +13,9 @@ This extension isn't part of KaTeX proper, so the script needs to be included using a CDN: ```html - - - + ``` @@ -32,9 +32,9 @@ want to use a `defer` or `onload` attribute. For example: ```html - - - + + + + + ``` KaTeX also provides minified versions: ```html - - + + ``` > The loading of scripts are [deferred using `defer` attribute](https://developer.mozilla.org/en/HTML/Element/script#Attributes) @@ -41,11 +41,11 @@ ECMAScript module is also available: ```html - - + + ``` > Use [`nomodule` attribute](https://developer.mozilla.org/en/HTML/Element/script#Attributes) diff --git a/website/versioned_docs/version-0.10.0-rc.1/cli.md b/website/versioned_docs/version-0.10.0/cli.md similarity index 96% rename from website/versioned_docs/version-0.10.0-rc.1/cli.md rename to website/versioned_docs/version-0.10.0/cli.md index 3affa065..2c8ef130 100644 --- a/website/versioned_docs/version-0.10.0-rc.1/cli.md +++ b/website/versioned_docs/version-0.10.0/cli.md @@ -1,5 +1,5 @@ --- -id: version-0.10.0-rc.1-cli +id: version-0.10.0-cli title: CLI original_id: cli --- @@ -40,7 +40,7 @@ Makes \color behave like LaTeX's 2-argument \textcolor, instead of LaTeX's one-a Turn on strict / LaTeX faithfulness mode, which throws an error if the input uses features that are not supported by LaTeX ### `-s, --max-size ` -If non-zero, all user-specified sizes, e.g. in \rule{500em}{500em}, will be capped to maxSize ems. Otherwise, elements and spaces can be arbitrarily large (default: 0) +If non-zero, all user-specified sizes, e.g. in \rule{500em}{500em}, will be capped to maxSize ems. Otherwise, elements and spaces can be arbitrarily large (default: Infinity) ### `-e, --max-expand ` Limit the number of macro expansions to the specified number, to prevent e.g. infinite macro loops. If set to Infinity, the macro expander will try to fully expand as in LaTeX. diff --git a/website/versioned_docs/version-0.10.0-rc.1/error.md b/website/versioned_docs/version-0.10.0/error.md similarity index 97% rename from website/versioned_docs/version-0.10.0-rc.1/error.md rename to website/versioned_docs/version-0.10.0/error.md index 884918f8..eae3010a 100644 --- a/website/versioned_docs/version-0.10.0-rc.1/error.md +++ b/website/versioned_docs/version-0.10.0/error.md @@ -1,5 +1,5 @@ --- -id: version-0.10.0-rc.1-error +id: version-0.10.0-error title: Handling Errors original_id: error --- diff --git a/website/versioned_docs/version-0.10.0-rc.1/font.md b/website/versioned_docs/version-0.10.0/font.md similarity index 99% rename from website/versioned_docs/version-0.10.0-rc.1/font.md rename to website/versioned_docs/version-0.10.0/font.md index 5c9397b7..47c148f0 100644 --- a/website/versioned_docs/version-0.10.0-rc.1/font.md +++ b/website/versioned_docs/version-0.10.0/font.md @@ -1,5 +1,5 @@ --- -id: version-0.10.0-rc.1-font +id: version-0.10.0-font title: Font original_id: font --- diff --git a/website/versioned_docs/version-0.10.0-rc.1/issues.md b/website/versioned_docs/version-0.10.0/issues.md similarity index 97% rename from website/versioned_docs/version-0.10.0-rc.1/issues.md rename to website/versioned_docs/version-0.10.0/issues.md index 23f95d6a..d4bd2325 100644 --- a/website/versioned_docs/version-0.10.0-rc.1/issues.md +++ b/website/versioned_docs/version-0.10.0/issues.md @@ -1,5 +1,5 @@ --- -id: version-0.10.0-rc.1-issues +id: version-0.10.0-issues title: Common Issues original_id: issues --- diff --git a/website/versioned_docs/version-0.10.0-rc.1/libs.md b/website/versioned_docs/version-0.10.0/libs.md similarity index 87% rename from website/versioned_docs/version-0.10.0-rc.1/libs.md rename to website/versioned_docs/version-0.10.0/libs.md index 0307c242..39d7b471 100644 --- a/website/versioned_docs/version-0.10.0-rc.1/libs.md +++ b/website/versioned_docs/version-0.10.0/libs.md @@ -1,5 +1,5 @@ --- -id: version-0.10.0-rc.1-libs +id: version-0.10.0-libs title: Extensions & Libraries original_id: libs --- @@ -35,3 +35,7 @@ If you want to render math written in [AsciiMath](http://asciimath.org/), you'll need to first convert AsciiMath into LaTeX input, then call KaTeX. - [asciimath2tex](https://github.com/christianp/asciimath2tex): Converts AsciiMath to TeX, with KaTeX in mind + +### Canvas LaTeX + +- [canvas-latex](https://github.com/CurriculumAssociates/canvas-latex): Renders mathematical expressions on HTML5's canvas element. Supports popular libraries like: CreateJS, and PIXI. diff --git a/website/versioned_docs/version-0.10.0-rc.1/node.md b/website/versioned_docs/version-0.10.0/node.md similarity index 95% rename from website/versioned_docs/version-0.10.0-rc.1/node.md rename to website/versioned_docs/version-0.10.0/node.md index 8c3915f1..d5ec7354 100644 --- a/website/versioned_docs/version-0.10.0-rc.1/node.md +++ b/website/versioned_docs/version-0.10.0/node.md @@ -1,5 +1,5 @@ --- -id: version-0.10.0-rc.1-node +id: version-0.10.0-node title: Node.js original_id: node --- diff --git a/website/versioned_docs/version-0.10.0-rc.1/options.md b/website/versioned_docs/version-0.10.0/options.md similarity index 99% rename from website/versioned_docs/version-0.10.0-rc.1/options.md rename to website/versioned_docs/version-0.10.0/options.md index b610ff58..94610594 100644 --- a/website/versioned_docs/version-0.10.0-rc.1/options.md +++ b/website/versioned_docs/version-0.10.0/options.md @@ -1,5 +1,5 @@ --- -id: version-0.10.0-rc.1-options +id: version-0.10.0-options title: Options original_id: options --- diff --git a/website/versioned_docs/version-0.10.0-rc.1/security.md b/website/versioned_docs/version-0.10.0/security.md similarity index 95% rename from website/versioned_docs/version-0.10.0-rc.1/security.md rename to website/versioned_docs/version-0.10.0/security.md index ba40b13c..131663ef 100644 --- a/website/versioned_docs/version-0.10.0-rc.1/security.md +++ b/website/versioned_docs/version-0.10.0/security.md @@ -1,5 +1,5 @@ --- -id: version-0.10.0-rc.1-security +id: version-0.10.0-security title: Security original_id: security --- diff --git a/website/versioned_docs/version-0.10.0-rc.1/support_table.md b/website/versioned_docs/version-0.10.0/support_table.md similarity index 99% rename from website/versioned_docs/version-0.10.0-rc.1/support_table.md rename to website/versioned_docs/version-0.10.0/support_table.md index 07feea59..9b39e98a 100644 --- a/website/versioned_docs/version-0.10.0-rc.1/support_table.md +++ b/website/versioned_docs/version-0.10.0/support_table.md @@ -1,5 +1,5 @@ --- -id: version-0.10.0-rc.1-support_table +id: version-0.10.0-support_table title: Support Table original_id: support_table --- @@ -7,7 +7,7 @@ This is a list of TeX functions, sorted alphabetically. This list includes funct If you know the shape of a character, but not its name, [Detexify](http://detexify.kirelabs.org/classify.html) can help. - +