diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 416268e3..bdb2058d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -2,9 +2,9 @@ name: CI on: push: - branches: [ master ] + branches: [ main ] pull_request: - branches: [ master ] + branches: [ main ] jobs: test: diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 0b57a77e..c42101ff 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -2,9 +2,9 @@ name: "CodeQL" on: push: - branches: [ master ] + branches: [ main ] pull_request: - branches: [ master ] + branches: [ main ] schedule: - cron: '0 0 * * 1' diff --git a/.github/workflows/fonts.yml b/.github/workflows/fonts.yml index a85a4d38..f26d01e1 100644 --- a/.github/workflows/fonts.yml +++ b/.github/workflows/fonts.yml @@ -2,7 +2,7 @@ name: Fonts on: pull_request_target: - branches: [ master ] + branches: [ main ] types: [ labeled ] # 'build fonts' label jobs: diff --git a/.github/workflows/screenshotter.yml b/.github/workflows/screenshotter.yml index b9cdacbe..f5711e33 100644 --- a/.github/workflows/screenshotter.yml +++ b/.github/workflows/screenshotter.yml @@ -2,9 +2,9 @@ name: Screenshotter on: push: - branches: [ master ] + branches: [ main ] pull_request_target: - branches: [ master ] + branches: [ main ] jobs: screenshotter: diff --git a/.releaserc b/.releaserc index a1edab66..c7a2eeaf 100644 --- a/.releaserc +++ b/.releaserc @@ -1,4 +1,5 @@ { + "branches": "main", "plugins": [ ["@semantic-release/commit-analyzer", { "releaseRules": [ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b34e378c..34997805 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -93,7 +93,7 @@ You can view the report in `coverage/lcov-report/index.html`. To ensure the final output looks good, we screenshot different expressions. These tests can be run by using the -[screenshotter docker](https://github.com/KaTeX/KaTeX/tree/master/dockers/screenshotter). +[screenshotter docker](https://github.com/KaTeX/KaTeX/tree/main/dockers/screenshotter). The screenshot tests should be run if you add anything more significant than individual symbols. These tests are not automatically run, so please remember! @@ -107,7 +107,7 @@ created it, add a screenshot test. See [ss_data.yaml](test/screenshotter/ss_data.yaml). You can use our -[texcmp](https://github.com/KaTeX/KaTeX/tree/master/dockers/texcmp) tool +[texcmp](https://github.com/KaTeX/KaTeX/tree/main/dockers/texcmp) tool to compare the outputs of a screenshot test as generated by KaTeX and LaTeX. It's often useful to attach the resulting "visual diff" to your pull request with a new feature. diff --git a/README.md b/README.md index f547fab2..70a35e27 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # [KaTeX](https://katex.org/) [![npm](https://img.shields.io/npm/v/katex.svg)](https://www.npmjs.com/package/katex) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) -[![CI](https://github.com/KaTeX/KaTeX/workflows/CI/badge.svg?branch=master&event=push)](https://github.com/KaTeX/KaTeX/actions?query=workflow%3ACI) -[![codecov](https://codecov.io/gh/KaTeX/KaTeX/branch/master/graph/badge.svg)](https://codecov.io/gh/KaTeX/KaTeX) +[![CI](https://github.com/KaTeX/KaTeX/workflows/CI/badge.svg?branch=main&event=push)](https://github.com/KaTeX/KaTeX/actions?query=workflow%3ACI) +[![codecov](https://codecov.io/gh/KaTeX/KaTeX/branch/main/graph/badge.svg)](https://codecov.io/gh/KaTeX/KaTeX) [![Discussions](https://img.shields.io/badge/Discussions-join-brightgreen)](https://github.com/KaTeX/KaTeX/discussions) [![jsDelivr](https://data.jsdelivr.com/v1/package/npm/katex/badge?style=rounded)](https://www.jsdelivr.com/package/npm/katex) ![katex.min.js size](https://img.badgesize.io/https://unpkg.com/katex/dist/katex.min.js?compression=gzip) diff --git a/docs/font.md b/docs/font.md index c00fb2c5..828612e4 100644 --- a/docs/font.md +++ b/docs/font.md @@ -41,6 +41,6 @@ variable to `"true"` or `"false"`, respectively. The default build of KaTeX expects the KaTeX fonts to be located in a directory called `fonts` which is a sibling of the `katex.min.css` stylesheet. This can be changed as follows: -1. At the top of the [fonts.less](https://github.com/KaTeX/KaTeX/blob/master/src/fonts.less) file, set `@font-folder` to the location of your fonts. You can use relative or absolute paths, so setting it to `"/fonts"` would cause it to search for the fonts in a root `fonts` folder, while `"../fonts"` would search in a `fonts` directory one level above the `katex.min.css` file. +1. At the top of the [fonts.less](https://github.com/KaTeX/KaTeX/blob/main/src/fonts.less) file, set `@font-folder` to the location of your fonts. You can use relative or absolute paths, so setting it to `"/fonts"` would cause it to search for the fonts in a root `fonts` folder, while `"../fonts"` would search in a `fonts` directory one level above the `katex.min.css` file. 2. Rebuild KaTeX by running `yarn build` from the top-level directory. 3. Use the newly generated `dist/katex.min.css` file, and place the fonts where you indicated. diff --git a/docs/libs.md b/docs/libs.md index 2d9a8d94..59d0cd28 100644 --- a/docs/libs.md +++ b/docs/libs.md @@ -7,9 +7,9 @@ title: Extensions & Libraries These extensions are provided by KaTeX. - [Auto-render](autorender.md): Automatically renders all of the math inside text -- [Copy-tex](https://github.com/Khan/KaTeX/tree/master/contrib/copy-tex): When selecting and copying KaTeX-rendered elements, copies their LaTeX source to the clipboard -- [`math/tex` Custom Script Type](https://github.com/Khan/KaTeX/tree/master/contrib/mathtex-script-type): Automatically displays LaTeX math inside `script` tags with `type=math/tex` -- [mhchem](https://github.com/Khan/KaTeX/tree/master/contrib/mhchem): Write beautiful chemical equations easily +- [Copy-tex](https://github.com/KaTeX/KaTeX/tree/main/contrib/copy-tex): When selecting and copying KaTeX-rendered elements, copies their LaTeX source to the clipboard +- [`math/tex` Custom Script Type](https://github.com/KaTeX/KaTeX/tree/main/contrib/mathtex-script-type): Automatically displays LaTeX math inside `script` tags with `type=math/tex` +- [mhchem](https://github.com/KaTeX/KaTeX/tree/main/contrib/mhchem): Write beautiful chemical equations easily ## Libraries diff --git a/docs/node.md b/docs/node.md index cecc489a..b93da396 100644 --- a/docs/node.md +++ b/docs/node.md @@ -88,7 +88,7 @@ Note, however, that you do not need to include `katex.js` on the client. ## Using mhchem extension -The [mhchem extension](https://github.com/Khan/KaTeX/tree/master/contrib/mhchem) +The [mhchem extension](https://github.com/KaTeX/KaTeX/tree/main/contrib/mhchem) adds its features by modifying the `katex` module. So you can use KaTeX with mhchem in Node as follows: diff --git a/docs/options.md b/docs/options.md index 8533f0cc..ae34b9a5 100644 --- a/docs/options.md +++ b/docs/options.md @@ -15,7 +15,7 @@ You can provide an object of options as the last argument to [`katex.render` and - `fleqn`: `boolean`. If `true`, display math renders flush left with a `2em` left margin, like `\documentclass[fleqn]` in LaTeX with the `amsmath` package. - `throwOnError`: `boolean`. If `true` (the default), KaTeX will throw a `ParseError` when it encounters an unsupported command or invalid LaTeX. If `false`, KaTeX will render unsupported commands as text, and render invalid LaTeX as its source code with hover text giving the error, in the color given by `errorColor`. - `errorColor`: `string`. A color string given in the format `"#XXX"` or `"#XXXXXX"`. This option determines the color that unsupported commands and invalid LaTeX are rendered in when `throwOnError` is set to `false`. (default: `#cc0000`) -- `macros`: `object`. A collection of custom macros. Each macro is a property with a name like `\name` (written `"\\name"` in JavaScript) which maps to a string that describes the expansion of the macro, or a function that accepts an instance of `MacroExpander` as first argument and returns the expansion as a string. `MacroExpander` is an internal API and subject to non-backwards compatible changes. See [`src/defineMacro.js`](https://github.com/KaTeX/KaTeX/blob/master/src/defineMacro.js) for its usage. Single-character keys can also be included in which case the character will be redefined as the given macro (similar to TeX active characters). *This object will be modified* if the LaTeX code defines its own macros via `\gdef`, which enables consecutive calls to KaTeX to share state. +- `macros`: `object`. A collection of custom macros. Each macro is a property with a name like `\name` (written `"\\name"` in JavaScript) which maps to a string that describes the expansion of the macro, or a function that accepts an instance of `MacroExpander` as first argument and returns the expansion as a string. `MacroExpander` is an internal API and subject to non-backwards compatible changes. See [`src/defineMacro.js`](https://github.com/KaTeX/KaTeX/blob/main/src/defineMacro.js) for its usage. Single-character keys can also be included in which case the character will be redefined as the given macro (similar to TeX active characters). *This object will be modified* if the LaTeX code defines its own macros via `\gdef`, which enables consecutive calls to KaTeX to share state. - `minRuleThickness`: `number`. Specifies a minimum thickness, in ems, for fraction lines, `\sqrt` top lines, `{array}` vertical lines, `\hline`, `\hdashline`, `\underline`, `\overline`, and the borders of `\fbox`, `\boxed`, and `\fcolorbox`. The usual value for these items is `0.04`, so for `minRuleThickness` to be effective it should probably take a value slightly above `0.04`, say `0.05` or `0.06`. Negative values will be ignored. - `colorIsTextColor`: `boolean`. In early versions of both KaTeX (<0.8.0) and MathJax, the `\color` function expected the content to be a function argument, as in `\color{blue}{hello}`. In current KaTeX, `\color` is a switch, as in `\color{blue} hello`. This matches LaTeX behavior. If you want the old `\color` behavior, set option `colorIsTextColor` to true. - `maxSize`: `number`. All user-specified sizes, e.g. in `\rule{500em}{500em}`, will be capped to `maxSize` ems. If set to `Infinity` (the default), users can make elements and spaces arbitrarily large. diff --git a/docs/support_table.md b/docs/support_table.md index 39c635e7..3964ea87 100644 --- a/docs/support_table.md +++ b/docs/support_table.md @@ -219,7 +219,7 @@ table td { |\cdot|$\cdot$|| |\cdotp|$\cdotp$|| |\cdots|$\cdots$|| -|\ce |${\mathrm{C}{\vphantom{X}}_{\smash[t]{6}}\mathrm{H}{\vphantom{X}}_{\smash[t]{5}}{-}\mathrm{CHO}}$|`\ce{C6H5-CHO}` Requires an [extension](https://github.com/KaTeX/KaTeX/tree/master/contrib/mhchem/)| +|\ce |${\mathrm{C}{\vphantom{X}}_{\smash[t]{6}}\mathrm{H}{\vphantom{X}}_{\smash[t]{5}}{-}\mathrm{CHO}}$|`\ce{C6H5-CHO}` Requires an [extension](https://github.com/KaTeX/KaTeX/tree/main/contrib/mhchem/)| |\cee|Not supported|Deprecated by mhchem |\centerdot|$a\centerdot b$|`a\centerdot b`| |\cf|Not supported|Deprecated by mhchem; @@ -868,7 +868,7 @@ use `\ce` instead| |\providecommand|$\providecommand\greet{\text{Hello}} \greet$|`\providecommand\greet{\text{Hello}} \greet`| |\psi|$\psi$|| |\Psi|$\Psi$|| -|\pu |${123~\mathchoice{\textstyle\frac{\mathrm{kJ}}{\mathrm{mol}}}{\frac{\mathrm{kJ}}{\mathrm{mol}}}{\frac{\mathrm{kJ}}{\mathrm{mol}}}{\frac{\mathrm{kJ}}{\mathrm{mol}}}}$|`\pu{123 kJ//mol}` Requires an [extension](https://github.com/KaTeX/KaTeX/tree/master/contrib/mhchem/)| +|\pu |${123~\mathchoice{\textstyle\frac{\mathrm{kJ}}{\mathrm{mol}}}{\frac{\mathrm{kJ}}{\mathrm{mol}}}{\frac{\mathrm{kJ}}{\mathrm{mol}}}{\frac{\mathrm{kJ}}{\mathrm{mol}}}}$|`\pu{123 kJ//mol}` Requires an [extension](https://github.com/KaTeX/KaTeX/tree/main/contrib/mhchem/)| ## QR diff --git a/website/core/Footer.js b/website/core/Footer.js index 58ae740e..2a668e6a 100644 --- a/website/core/Footer.js +++ b/website/core/Footer.js @@ -89,7 +89,7 @@ class Footer extends React.Component { />
- Licensed under MIT License
+ Licensed under MIT License
{this.props.config.copyright}
diff --git a/website/pages/en/users.js b/website/pages/en/users.js index 49bbb3b6..23491cdf 100644 --- a/website/pages/en/users.js +++ b/website/pages/en/users.js @@ -16,7 +16,7 @@ class Users extends React.Component { if ((siteConfig.users || []).length === 0) { return null; } - const editUrl = siteConfig.repoUrl + '/edit/master/website/siteConfig.js'; + const editUrl = siteConfig.repoUrl + '/edit/main/website/siteConfig.js'; const showcase = siteConfig.users.map((user, i) => { return ( diff --git a/website/pages/index.html b/website/pages/index.html index 9fa2f9ef..c37b23a1 100644 --- a/website/pages/index.html +++ b/website/pages/index.html @@ -124,7 +124,7 @@ Created by Emily Eisenberg and Sophie Alpert -
MIT License · Built from the hard work of many contributors +
MIT License · Built from the hard work of many contributors
Cross-browser testing via Browserstack
This site is powered by Netlify diff --git a/website/static/404.html b/website/static/404.html index d085cc5e..d33217b3 100644 --- a/website/static/404.html +++ b/website/static/404.html @@ -81,7 +81,7 @@ Created by Emily Eisenberg and Sophie Alpert -
MIT License · Built from the hard work of MIT License · Built from the hard work of many contributors