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

Add markdown-help command and auto-generate CLI documentation (#1518)

Browse Source 
* Add `markdown-help` command and update CLI documentation

* Auto-generate cli.md before start, build, and publish

* Update cli.md.template
This commit is contained in:
ylemkimon
2018-07-30 01:44:43 +09:00
committed by GitHub
parent c1b6668cf0
commit 20c9440318
5 changed files with 41 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/cli.md.template Normal file
View File

@@ -0,0 +1,20 @@
---
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`.
```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`
> To use CLI from local clone, you need to build the project first by
running `npm run build`
## Options