Skip to content

Configuration

Customize MergDown2TeX to match your workflow.

Access settings

  1. Open Obsidian
  2. Go to Settings → Community plugins
  3. Click MergDown2TeX → Options

General settings

Document class

Setting Default Description
documentclass report LaTeX document class

Options: article, report, book, letter, beamer

\documentclass[12pt]{report}  % Default
\documentclass[12pt]{article} % Alternative

Font size

Setting Default Description
fontsize 12pt Font size

Options: 10pt, 11pt, 12pt, 14pt

Bibliography settings

Bibliography file

Setting Default Description
bibliography "" Path to .bib file

Usage:

---
bibliography: references.bib
---

Example references.bib:

@article{smith2020,
  author  = {Smith, John},
  title   = {Important Research},
  journal = {Journal of Science},
  year    = {2020},
  volume  = {1},
  pages   = {1-10}
}

Citation style

Setting Default Description
citationStyle authoryear Citation style

Options:

  • authoryear → \citep{smith2020}
  • numeric → \cite{smith2020}
  • alphabetic → \cite{smith2020}
  • super → \cite{smith2020}

Preamble settings

Custom preamble

Setting Default Description
customPreamble "" Custom LaTeX preamble

Usage:

---
customPreamble: |
  \usepackage{custom-package}
  \newcommand{\mycommand}{...}
---

Example:

% Auto-generated preamble
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}

% Your custom preamble
\usepackage{tikz}
\usepackage{siunitx}

% Continue...
\begin{document}

Features settings

Minted (syntax highlighting)

Setting Default Description
useMinted true Syntax highlighting with minted

When enabled:

\usepackage{minted}

\begin{document}

\begin{minted}{python}
def hello():
    print("Hello, World!")
\end{minted}

\end{document}

Tcolorbox (callouts)

Setting Default Description
useTcolorbox true Callouts as tcolorbox

When enabled:

\usepackage{tcolorbox}

\begin{document}

\begin{tcolorbox}[colback=blue!5!white, colframe=blue!75!black]
This is a callout.
\end{tcolorbox}

\end{document}

Mermaid settings

DPI

Setting Default Description
mermaidDpi 150 Mermaid diagram resolution

Options: 72, 96, 150, 300

Usage:

---
mermaidDpi: 300
---

!!! info "Higher DPI" Higher DPI produces clearer diagrams but larger files.

Images settings

Image folder

Setting Default Description
imageFolder "" Custom image folder

Usage:

---
imageFolder: assets/images
---

Image format

Setting Default Description
imageFormat png Image format for Mermaid

Options: png, svg

Compilation settings

Podman path

Setting Default Description
podmanPath podman Path to Podman executable

Container name

Setting Default Description
containerName mergdown2tex-env Container image name

Timeout

Setting Default Description
compilationTimeout 60 Compilation timeout in seconds

Example configuration

Academic paper

---
title: "Research Paper"
author: "John Doe"
documentclass: article
fontsize: 11pt
bibliography: references.bib
citationStyle: authoryear
useMinted: true
useTcolorbox: true
mermaidDpi: 300
---

Thesis

---
title: "My Thesis"
author: "Jane Doe"
documentclass: report
fontsize: 12pt
bibliography: bibliography.bib
citationStyle: authoryear
customPreamble: |
  \usepackage{glossaries}
  \makeglossaries
useMinted: true
useTcolorbox: true
mermaidDpi: 300
---

Beamer presentation

---
title: "Presentation"
author: "John Doe"
documentclass: beamer
fontsize: 10pt
bibliography: references.bib
citationStyle: numeric
---

Next steps