mdframed

https://marcodaniel.github.io/mdframed/
Admin
mdframed is a LaTeX package that provides auto-split frame environments for drawing customizable...
Tokens:1,914
Snippets:21
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Advanced Theorem Style with TikZ and Frametitle

Source: https://marcodaniel.github.io/mdframed

Defines a theorem style using TikZ for advanced frametitle background shading and a green rule. This example demonstrates more complex styling options for theorem environments, including different background colors for the title.

```latex
\mdfdefinestyle{theoremstyle}{
linecolor=red,linewidth=2pt,%
frametitlerule=true,%
apptotikzsetting={\tikzset{mdfframetitlebackground/.append style={
shade,left color=white, right color=blue!20}}},%
frametitlerulecolor=green!60,
frametitlerulewidth=1pt,
innertopmargin=\topskip,
}
\mdtheorem[style=theoremstyle]{definition}{Definition}
\begin{definition}[Inhomogeneous linear]
\ExampleText
\end{definition}
\begin{definition*}[Inhomogeneous linear]
\ExampleText
\end{definition*}


```

--------------------------------

### Load the mdframed package

Source: https://marcodaniel.github.io/mdframed

Standard package inclusion. Loading after xcolor is recommended.

```latex
\usepackage{mdframed}
```

--------------------------------

### Set global mdframed options

Source: https://marcodaniel.github.io/mdframed

Use mdfsetup to define global configuration keys for frames.

```latex
\mdfsetup{leftmargin=12pt}
```

--------------------------------

### Configure frame rendering methods

Source: https://marcodaniel.github.io/mdframed

Specify the backend engine for drawing frames via the framemethod option.

```latex
\usepackage[framemethod=default]{mdframed} % default setting
\usepackage[framemethod=tikz]{mdframed}
\usepackage[framemethod=pstricks]{mdframed}
```

--------------------------------

### Create a framed environment

Source: https://marcodaniel.github.io/mdframed

Wrap content within the mdframed environment to apply the frame.

```latex
\begin{mdframed}
CONTENTS
\end{mdframed}
```

--------------------------------

### Define Custom Warning Style for mdframed

Source: https://marcodaniel.github.io/mdframed

Defines a custom style named 'warning' for mdframed environments. This style includes red lines, specific margins, and a custom symbol using TikZ for warnings. Use this for visually distinct warning boxes.

```latex
\tikzset{
warningsymbol/.style={
rectangle,draw=red,
fill=white,scale=1,
overlay}}
\mdfdefinestyle{warning}{
hidealllines=true,leftline=true,
skipabove=12,skipbelow=12pt,
innertopmargin=0.4em,%
innerbottommargin=0.4em,%
innerrightmargin=0.7em,%
rightmargin=0.7em,%
innerleftmargin=1.7em,%
leftmargin=0.7em,%
middlelinewidth=.2em,%
linecolor=red,%
fontcolor=red,%
firstextra={\path let \p1=(P), \p2=(O) in ($(\x2,0)+0.5*(0,\y1)$)
node[warningsymbol] {\$};},%
secondextra={\path let \p1=(P), \p2=(O) in ($(\x2,0)+0.5*(0,\y1)$)
node[warningsymbol] {\$};},%
middleextra={\path let \p1=(P), \p2=(O) in ($(\x2,0)+0.5*(0,\y1)$)
node[warningsymbol] {\$};},%
singleextra={\path let \p1=(P), \p2=(O) in ($(\x2,0)+0.5*(0,\y1)$)
node[warningsymbol] {\$};},
}
\begin{mdframed}[style=warning]
\ExampleText
\end{mdframed}


```

--------------------------------

### Define Theorem Style with Frametitle

Source: https://marcodaniel.github.io/mdframed

Defines a theorem style with a red frame rule and a gray background for the frametitle. This is useful for creating distinct theorem or definition blocks. The 'definition' environment is used here.

```latex
\mdfdefinestyle{theoremstyle}{
linecolor=red,linewidth=2pt,%
frametitlerule=true,%
frametitlebackgroundcolor=gray!20,
innertopmargin=\topskip,
}
\mdtheorem[style=theoremstyle]{definition}{Definition}
\begin{definition}
\ExampleText
\end{definition}
\begin{definition}[Inhomogeneous linear]
\ExampleText
\end{definition}
\begin{definition*}[Inhomogeneous linear]
\ExampleText
\end{definition*}


```

--------------------------------

### Theorem Style with TikZ Shading and Shadow

Source: https://marcodaniel.github.io/mdframed

Defines a theorem style with rounded corners, a shadow effect, and TikZ shading for both the frame background and the frametitle background. This creates a visually rich theorem box.

```latex
\mdtheorem[% 
apptotikzsetting={\tikzset{mdfbackground/.append style={
top color=yellow!40!white,
bottom color=yellow!80!black},
mdfframetitlebackground/.append style =% 
{top color=purple!40!white,
bottom color=purple!80!black}
}}, 
,roundcorner=10pt,middlelinewidth=2pt,
shadow=true,frametitlerule=true,frametitlerulewidth=4pt,
innertopmargin=10pt,% 
]{alternativtheorem}{Theorem}
\begin{alternativtheorem}[Inhomogeneous linear]
\ExampleText
\end{alternativtheorem}


```

--------------------------------

### Custom mdframed with TikZ Dashed Lines

Source: https://marcodaniel.github.io/mdframed

Configures an mdframed environment with various settings including skip distances, margins, line widths, and background colors. It also applies TikZ settings for a dashed yellow frame line, disabling the right and bottom lines.

```latex
\mdfsetup{splitbottomskip=0.8cm,splittopskip=0cm,
innerrightmargin=2cm,innertopmargin=1cm,%
innerlinewidth=2pt,outerlinewidth=2pt,
middlelinewidth=10pt,backgroundcolor=red,
linecolor=blue,middlelinecolor=gray,
tikzsetting={draw=yellow,line width=3pt,%
dashed,%
 dash pattern= on 10pt off 3pt}},
rightline=false,bottomline=false}
\begin{mdframed}
\ExampleText
\end{mdframed}


```
Tokens:
Raw