synthetica9/tufte-pandoc

A pandoc scaffold using the LaTeX Tufte style

Tufte-Pandoc

A template/scaffold that can be used to generate LaTeX documents.

Intended usage

# Clone into wanted directory:
git clone https://github.com/synthetica9/tufte-pandoc Report
cd Report

# Remove unneeded files:
./init.sh

# Build it:
nix-shell --run scons

After that, you should probably edit meta.yaml to add your own name, title and subtitle. After that, you can add files to md-src/.

Files

md-src/*.md

Every file should contain a chapter. Automatically discovered by scons.

meta.yaml

Contains variables for the document, such as the title, the subtitle, the author, the date.

header.tex

Anything contained here will be pasted into the header of the final LaTeX file. Recommended to contain things like \newcommands and such.

bibliography.bib

Biblatex file containing bibliography entries.

filters/*.lua

Filters that are run at various stages.

out.pdf

The final PDF file.

environments

You can place nix files here, they will be built and linked under the same name.

.build/

Internal build directory. You should assume this can be deleted at any time.

init.sh

Removes standard build files

Custom syntax

[!label]

Reference a label with cref. If you use [!Label] (with a capital), the reference is also capitalised.

[!!label]

Create a label.

captions

Captions are created as follows:

::: figure

FIGURE GOES HERE

---

CAPTION GOES HERE
[!!label]

:::

If you need a horizontal rule inside a figure but don't want a caption, that can be done as follows:

::: figure

FIGURE GOES HERE

---

CONTINUE WITH FIGURE

---

:::

The bottom rule will be deleted.

Software used

• scons
• pandoc
• pandoc-citeproc
• codebraid
• XeLaTeX

If you can’t use Nix for some reason, you’ll have to install at least this software.

Attribution

If you use this template, you can (but don't have to, as per the CC0 licensing) credit @hilhorst-19, which is included in the default Biblatex file.

Future work

• Use nix-build instead of nix-shell, for performance, persistence, and reproducibility.
• Rename the default filters to something more descriptive.
• Add an index file that explicitly lists chapters? (for easier reshuffling)

tufte-pandoc's Issues

Create label from first paragraph

Use [!!label] for explicit labels

Explicit is better than implicit

Fix README to use GitHub markdown

Use custom comparison function for symlinks created by nix

Principled solution to the hack here

Include script for continuous running

Should probably use entr for this

Switch to Github Actions

[!references] don't work with capitals

Squash on run init script

Use `local` for lua

That's not implicit for some reason

Automatically convert punctation after displaystyle equations to appear within those equations

https://tex.stackexchange.com/questions/7542/for-formal-articles-should-a-displayed-equation-be-followed-by-a-punctuation-to

Download citation styles only once

Lua filter crashes on empty Div block that is converted

Gather dependencies from the files

(Image dependencies, etc.)

Use title as title for the pdf, not `out.pfd`

How to handle offset parameter for figure and marginfigure

Thanks for a nice template/scaffold! A question, how can I / should I handle the offset parameter for figures and marginfigures? It would be convenient to be able to adjust vertical offset somehow. I refer to the offsets like 1.0in below:

\begin{marginfigure}[1.0in]

Use Execute everywhere we use subprocess now

Leaves dry-run intact.

Define Div -> enviornment conversions in header.yaml

use `niv` to manage nixpkgs version

https://github.com/nmattia/niv

Option to convert code block to align* env

Configurable like the divenvs