96abd90 · typeable/pandoc

5Synopsis

6========

7

8−pandoc [*options*] [*input-file*]...

8+`pandoc` [*options*] [*input-file*]...

9

10Description

11===========

333 provided. If you want to run a script in the working directory,

334 preface the filename with `./`.

335

336−`-M` *KEY[=VAL]*, `--metadata=`*KEY[:VAL]*

336+`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]

337

338: Set the metadata field *KEY* to the value *VAL*. A value specified

339 on the command line overrides a value specified in the document.

359

360: Specify the number of spaces per tab (default is 4).

361

362−`--track-changes=`*accept|reject|all*

362+`--track-changes=accept`|`reject`|`all`

363

364: Specifies what to do with insertions and deletions produced by the MS

365− Word "track-changes" feature. *accept* (the default), inserts all

365+ Word "track-changes" feature. `accept` (the default), inserts all

366− insertions, and ignores all deletions. *reject* inserts all

366+ insertions, and ignores all deletions. `reject` inserts all

367− deletions and ignores insertions. *all* puts in both insertions

367+ deletions and ignores insertions. `all` puts in both insertions

368 and deletions, wrapped in spans with `insertion` and `deletion`

369 classes, respectively. The author and time of change is

370− included. *all* is useful for scripting: only accepting changes

370+ included. `all` is useful for scripting: only accepting changes

371 from a certain reviewer, say, or before a certain date. This

372 option only affects the docx reader.

373

400 template appropriate for the output format will be used (see

401 `-D/--print-default-template`).

402

403−`-V` *KEY[=VAL]*, `--variable=`*KEY[:VAL]*

403+`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]

404

405: Set the template variable *KEY* to the value *VAL* when rendering the

406 document in standalone mode. This is generally only useful when the

423: Disable text wrapping in output. By default, text is wrapped

424 appropriately for the output format.

425

426−`--columns`=*NUMBER*

426+`--columns=`*NUMBER*

427

428: Specify length of lines in characters (for text wrapping).

429

445: Disables syntax highlighting for code blocks and inlines, even when

446 a language attribute is given.

447

448−`--highlight-style`=*STYLE*

448+`--highlight-style=`*STYLE*

449

450: Specifies the coloring style to be used in highlighted source code.

451 Options are `pygments` (the default), `kate`, `monochrome`,

536 `unnumbered` will never be numbered, even if `--number-sections`

537 is specified.

538

539−`--number-offset`=*NUMBER[,NUMBER,...]*,

539+`--number-offset=`*NUMBER*[`,`*NUMBER*`,`*...*]

540

541: Offset for section headings in HTML output (ignored in other

542 output formats). The first number is added to the section number for

568: Make list items in slide shows display incrementally (one by one).

569 The default is for lists to be displayed all at once.

570

571−`--slide-level`=*NUMBER*

571+`--slide-level=`*NUMBER*

572

573: Specifies that headers with the specified level create

574 slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers

585 rather than the header itself.

586 See [Section identifiers](#header-identifiers-in-html-latex-and-context), below.

587

588−`--email-obfuscation=`*none|javascript|references*

588+`--email-obfuscation=none`|`javascript`|`references`

589

590: Specify a method for obfuscating `mailto:` links in HTML documents.

591− *none* leaves `mailto:` links as they are. *javascript* obfuscates

591+ `none` leaves `mailto:` links as they are. `javascript` obfuscates

592− them using javascript. *references* obfuscates them by printing their

592+ them using javascript. `references` obfuscates them by printing their

593 letters as decimal or hexadecimal character references.

594

595−`--id-prefix`=*STRING*

595+`--id-prefix=`*STRING*

596

597: Specify a prefix to be added to all automatically generated identifiers

598 in HTML and DocBook output, and to footnote numbers in markdown output.

722 documents with few level 1 headers, one might want to use a chapter

723 level of 2 or 3.

724

725−`--latex-engine=`*pdflatex|lualatex|xelatex*

725+`--latex-engine=pdflatex`|`lualatex`|`xelatex`

726

727: Use the specified LaTeX engine when producing PDF output.

728 The default is `pdflatex`. If the engine is not in your PATH,

773Math rendering in HTML

774----------------------

775

776−`-m` [*URL*], `--latexmathml`[=*URL*]

776+`-m` [*URL*], `--latexmathml`[`=`*URL*]

777

778: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.

779 To insert a link to a local copy of the `LaTeXMathML.js` script,

783 several pages, it is much better to link to a copy of the script,

784 so it can be cached.

785

786−`--mathml`[=*URL*]

786+`--mathml`[`=`*URL*]

787

788: Convert TeX math to MathML (in `docbook` as well as `html` and `html5`).

789 In standalone `html` output, a small javascript (or a link to such a

790 script if a *URL* is supplied) will be inserted that allows the MathML to

791 be viewed on some browsers.

792

793−`--jsmath`[=*URL*]

793+`--jsmath`[`=`*URL*]

794

795: Use [jsMath] to display embedded TeX math in HTML output.

796 The *URL* should point to the jsMath load script (e.g.

799 no link to the jsMath load script will be inserted; it is then

800 up to the author to provide such a link in the HTML template.

801

802−`--mathjax`[=*URL*]

802+`--mathjax`[`=`*URL*]

803

804: Use [MathJax] to display embedded TeX math in HTML output.

805 The *URL* should point to the `MathJax.js` load script.

812 be processed by [gladTeX] to produce links to images of the typeset

813 formulas.

814

815−`--mimetex`[=*URL*]

815+`--mimetex`[`=`*URL*]

816

817: Render TeX math using the [mimeTeX] CGI script. If *URL* is not

818 specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.

819

820−`--webtex`[=*URL*]

820+`--webtex`[`=`*URL*]

821

822: Render TeX formulas using an external script that converts TeX

823 formulas to images. The formula will be concatenated with the URL

824 provided. If *URL* is not specified, the Google Chart API will be used.

825

826−`--katex`[=*URL*]

826+`--katex`[`=`*URL*]

827

828−: Use [KaTeX] to display embedded TeX math in HTML output.

828+: Use [KaTeX] to display embedded TeX math in HTML output.

829− The *URL* should point to the `katex.js` load script. If a *URL* is

829+ The *URL* should point to the `katex.js` load script. If a *URL* is

830− not provided, a link to the KaTeX CDN will be inserted.

830+ not provided, a link to the KaTeX CDN will be inserted.

831

832−`--katex-stylesheet=*URL*`

832+`--katex-stylesheet=`*URL*

833

834−: The *URL* should point to the `katex.css` stylesheet. If this option is

834+: The *URL* should point to the `katex.css` stylesheet. If this option is

835− not specified, a link to the KaTeX CDN will be inserted. Note that this

835+ not specified, a link to the KaTeX CDN will be inserted. Note that this

836− option does not imply `--katex`.

836+ option does not imply `--katex`.

837

838Options for wrapper scripts

839---------------------------