mirror of
https://github.com/Smaug123/KaTeX
synced 2025-10-05 03:08:40 +00:00
Replace Khan/KaTeX with KaTeX/KaTeX (#1781)
* Replace Khan/KaTeX with KaTeX/KaTeX * Remove RawGit links * Remove old files
This commit is contained in:
committed by
Kevin Barabash
parent
f4e24183d6
commit
112582daa5
@@ -2,7 +2,7 @@
|
||||
|
||||
We welcome pull requests to KaTeX. If you'd like to add a new symbol, or try to
|
||||
tackle adding a larger feature, keep reading. If you have any questions, or want
|
||||
help solving a problem, feel free to stop by our [gitter channel](https://gitter.im/Khan/KaTeX).
|
||||
help solving a problem, feel free to stop by our [gitter channel](https://gitter.im/KaTeX/KaTeX).
|
||||
|
||||
## Helpful contributions
|
||||
|
||||
@@ -13,7 +13,7 @@ KaTeX doesn't currently support. The documentation has pages listing
|
||||
You can check them to see if we don't support a function you like, or try your
|
||||
function in the interactive demo at [http://katex.org/](http://katex.org/).
|
||||
The wiki has a page that describes how to [examine TeX commands and where to find
|
||||
rules](https://github.com/Khan/KaTeX/wiki/Examining-TeX) which can be quite
|
||||
rules](https://github.com/KaTeX/KaTeX/wiki/Examining-TeX) which can be quite
|
||||
useful when adding new commands.
|
||||
|
||||
#### Single symbols
|
||||
@@ -78,7 +78,7 @@ copy/pasting the test case to be debugged into the editor. The permalink option
|
||||
can come in really useful when doing repeated runs of the same test case.
|
||||
|
||||
The Jest tests should be run after every change, even the addition of small
|
||||
symbols. However, [CircleCI](https://circleci.com/gh/Khan/KaTeX) will run these
|
||||
symbols. However, [CircleCI](https://circleci.com/gh/KaTeX/KaTeX) will run these
|
||||
tests when you submit a pull request, in case you forget.
|
||||
|
||||
If you make any changes to Parser.js, add Jest tests to ensure they work.
|
||||
@@ -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/Khan/KaTeX/tree/master/dockers/screenshotter).
|
||||
[screenshotter docker](https://github.com/KaTeX/KaTeX/tree/master/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/Khan/KaTeX/tree/master/dockers/texcmp) tool
|
||||
[texcmp](https://github.com/KaTeX/KaTeX/tree/master/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.
|
||||
@@ -161,7 +161,7 @@ will automatically run this command after switching to branches
|
||||
where `submodules/katex-fonts` point to different commits.
|
||||
|
||||
When submitting pull requests that update katex-fonts, you'll need to submit
|
||||
two pull requests: one for [KaTeX/katex-fonts](https:/github.com/KaTeX/katex-fonts) and one for [Khan/KaTeX](https://github.com/Khan/KaTeX).
|
||||
two pull requests: one for [KaTeX/katex-fonts](https:/github.com/KaTeX/katex-fonts) and one for [KaTeX/KaTeX](https://github.com/KaTeX/KaTeX).
|
||||
|
||||
For more info about how to use git submodules,
|
||||
see https://chrisjean.com/git-submodules-adding-using-removing-and-updating/.
|
||||
|
Reference in New Issue
Block a user