patrick/KaTeX
1
0
Fork 0
mirror of https://github.com/Smaug123/KaTeX synced 2025-10-05 11:18:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Small tweaks to documentation (#1527)

Browse Source
This commit is contained in:
Erik Demaine
2018-07-29 23:25:38 -04:00
committed by ylemkimon
parent a76c4b9a2f
commit c88fa70a62
10 changed files with 31 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/cli.md.template
View File

@@ -3,19 +3,19 @@ id: cli
title: CLI
---
KaTeX installed [using Node.js package managers](node.md) comes with a built-in CLI
which can be used to render TeX to HTML from the command line. By default, CLI will
take the input from `stdin`.
KaTeX installed [using Node.js package managers](node.md) comes with a
built-in command-line interface (CLI) which can be used to render TeX to HTML.
By default, CLI will take the input from standard input.
```bash
npx katex
```
> Above uses the `npx` command to run the locally installed executable.
You can execute with the relative path: `./node_modules/.bin/katex`
> Above uses the `npx` command to run the locally installed executable
after `npm install katex`. You can also execute with the relative path:
`./node_modules/.bin/katex`
> To use CLI from local clone, you need to build the project first by
running `yarn run build`. See [Building from Source](node.md#building-from-source)
for more details.
> To use the CLI from local Git clone, you need to build the project first.
See [Building from Source](node.md#building-from-source) for more details.
## Options