LaTeX package to include draw.io (diagrams.net) diagrams without having to manually export them.
This package requires draw.io desktop to be installed. For installation instructions please read https://github.com/jgraph/drawio-desktop/releases .
Required LaTeX dependencies (also listed in drawio.sty):
- [filemod] will check if source file *.drawio is newer than the produced *.pdf artifact and will trigger conversion.
- [write18] conversion is done through the drawio command line interface. Therefore, ensure that the 'shell-escape' option is set.
- [cache|nocache] if disabled, conversions are always be executed
bold = default
Currently, this package is not available through CTAN. Therefore, just download drawio.sty and place it next to your root tex file.
Add the following to your LaTeX header
\usepackage[]{drawio}
Then, whereever you want to include your diagram, use \includedrawio instead of \includegraphics. \includedrawio is just a wrapper for \includegraphics. It will convert a drawio diagram to a pdf file (vector graphics). This pdf file will live next to its corresponding *.drawio file.
\begin{figure}[ht]
\centering
\includedrawio[width=0.7\textwidth]{Figures/path/to/drawio/diagram/without/extension}
\caption{Some caption}
\label{fig:mylabel}
\end{figure}
If your drawio diagram file consists of mutiple pages, you might want to use
\includedrawiopage{Figures/path/to/drawio/diagram/without/extension}[12][0.7]
to include the 12th page. Note, the interface is slighlty different. Here, only textwidth can be set.
The generated pdf files will be created in the same directory as the original diagram. Let's say, you have a diagram a.drawio, then the pdf will be a.drawio.pdf. As drawio desktop has to be available to generate the diagrams, you might either add the pdf artifacts to .gitignore, e.g.
*.drawio.pdf
or you might want to explicitly add them to your repository. This might be advantageous, if you collaborate with others not having drawio desktop installed on their machines.
Within the example folder, you will find a minimal LaTeX setup of how to use this package.
The research leading to these results has received funding from the Carl Zeiss Foundation.
The research was performed at the Institute for Anthropomatics and Robotics - Intelligent Process Automation and Robotics Lab (IAR-IPR), Karlsruhe Institute of Technology (KIT).