Skip to content

Commit

Permalink
Add a blurb on LaTeX input to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lierdakil committed Dec 14, 2024
1 parent c699c68 commit 4fbc369
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

- Switch CI compiler to GHC 9.8.4.

- Add some potentially useful references to the documentation.

## 0.3.18.0

- Add `eqnInlineTableTemplate` and `eqnDisplayTemplate` options.
Expand Down
19 changes: 19 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,25 @@ Bug tracker: <https://github.com/lierdakil/pandoc-crossref/issues>

# Caveats

## LaTeX input (a.k.a. converting LaTeX to docx/epub/etc)

The principal aim of pandoc-crossref is to add references to Markdown.

Other input formats may happen to work also (basically if you can make Pandoc
citation syntax to work), but that's more of a happy coincidence than a
deliberate design decision.

In particular, LaTeX syntax is generally not recognized, although under some
specific conditions it may seem to kinda-sorta work.

Converting TeX to anything editable in general is nigh impossible, with TeX
being a Turing-complete layout language rather than a markup language. That was
one of the motivations for pandoc-crossref in the first place.

All that said, if you really need to use LaTeX as an input format, see the
discussions in <https://github.com/lierdakil/pandoc-crossref/issues/250> and
<https://github.com/lierdakil/pandoc-crossref/issues/131>.

## LaTeX output and `--include-in-header`

pandoc-crossref uses metadata variable `header-includes` to add LaTeX
Expand Down

0 comments on commit 4fbc369

Please sign in to comment.