Skip to content
Prev Previous commit
Next Next commit
Update README.md
  • Loading branch information
jdutant committed Feb 13, 2021
commit 20fe8fdee727fb308992f1366515400a19a8b717
16 changes: 14 additions & 2 deletions bibliography-place/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ author: "Julien Dutant"
Bibliography place
=======

**WORK IN PROGRESS**

Control the placement of a `citeproc`-generated bibliography
via Pandoc templates.

Expand Down Expand Up @@ -40,6 +38,9 @@ places it in a `$referencesblock$` variable instead.
Usage
----

Call the filter from the command line or the defaults file. *It must be called
after citeproc*.

Place references with the `$referencesblock` variable:

```
Expand All @@ -53,3 +54,14 @@ $endif$
$if(referencesblock)$$referencesblock$$endif$
```

Warnings and troubleshooting
----------------------------

The filter must be called after *citeproc*.

If you process the document with another or no bibliography engine, the
reference sections will simply be erased.

If you use the filter with the default pandoc templates or with a template
that does not use `$referencesblock$` your bibliography will not be printed.