Skip to content
Snippets Groups Projects
Commit be92dcd1 authored by Sarah Lim's avatar Sarah Lim
Browse files

Update README to include claim environment

For some reason, `claim` was missing in both the table of supported
environments, as well as the required environment definitions in the
header file.
parent 8fffd31c
No related branches found
No related tags found
Loading
......@@ -8,6 +8,7 @@ The extension supports the following theorem environments:
| Supported environment | Supported Markdown identifiers |
|-|-|
| `claim` | `Claim` |
| `definition` | `Definition`, `Def` |
| `theorem` | `Theorem`, `Thm` |
| `lemma` | `Lemma` |
......@@ -111,6 +112,7 @@ Note that you will always need to include the following header file using Pandoc
```latex
% examples/header.tex
\usepackage{amsthm}
\newtheorem{claim}{Claim}
\newtheorem{definition}{Definition}
\newtheorem{lemma}{Lemma}
\newtheorem{theorem}{Theorem}
......@@ -118,6 +120,24 @@ Note that you will always need to include the following header file using Pandoc
\newtheorem{assumption}{Assumption}
```
You can also define these environments directly in the document, using YAML frontmatter to avoid passing `-H="header.tex"`:
```md
---
title: Glamorous paper
header-includes:
\usepackage{amsthm}
\newtheorem{claim}{Claim}
\newtheorem{definition}{Definition}
\newtheorem{lemma}{Lemma}
\newtheorem{theorem}{Theorem}
\newtheorem{example}{Example}
\newtheorem{assumption}{Assumption}
---
```
Finally, you can choose to add these environments directly to your chosen template, eliminating the need to define them in every document.
### Syntax
pandoc-theorem repurposes the syntax for [definition lists](https://pandoc.org/MANUAL.html#definition-lists), checking for [recognized identifiers](#identifiers).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment