Update docs (mostly), fixes, etc
This commit is contained in:
@@ -1,42 +1,10 @@
|
||||
\newpage
|
||||
\subsection{Extras}
|
||||
\subsubsection{BibTeX}
|
||||
\textit{Included in \texttt{recommended} and up}
|
||||
|
||||
\section{BibTeX}
|
||||
Use \verb|\setupBiber|\{\textit{/path/to/your/bib/sources.bib file}\} in the preamble to prepare, then use \verb|\printbib| to print your bibliography.
|
||||
|
||||
To add more sources, simply use bibter's built-in macro \verb|\addbibresource|\textit{\{filepath\}}, which will load your \texttt{.bib} file.
|
||||
You need to use that inside the preamble as well.
|
||||
|
||||
|
||||
\subsubsection{Glossary}
|
||||
\textit{Included in \texttt{recommended} and up}
|
||||
|
||||
\section{Glossary}
|
||||
Use \verb|\setupGlossary| in the preamble to prepare, then use the normal glossary commands to add entries to the glossary. When you want to print it, use \verb|\printGlossary|.
|
||||
|
||||
\subsubsection{Minted}
|
||||
\textit{Included in \texttt{full}}
|
||||
|
||||
Be sure to enable \texttt{-shell-escape} for your compiler
|
||||
\textit{(Note: Some newer versions of LaTeX do no longer require this and it is better to keep it turned off for security reasons, if it works without)}!
|
||||
|
||||
When \texttt{minted} is available via these helpers, you will also have access to the \texttt{code} environment:
|
||||
|
||||
\begin{minted}{latex}
|
||||
\begin{code}{language}
|
||||
//Code goes here
|
||||
\end{code}
|
||||
\end{minted}
|
||||
|
||||
This is nothing different than a wrapper for a minted environment with a box drawn around it.
|
||||
|
||||
Example (in python):
|
||||
|
||||
\begin{code}{python}
|
||||
def hello_world():
|
||||
print("hello world!")
|
||||
\end{code}
|
||||
|
||||
If you want to print code inline, use \verb|\inlinecode|\textit{\{string\}}, which renders to \inlinecode{code}.
|
||||
|
||||
\textit{Caveat: This is not using the \texttt{verbatim} environment due to various limitations of that environment and instead is simply using} \verb|\texttt{}|, so you cannot use this to print \LaTeX-commands
|
||||
|
||||
Reference in New Issue
Block a user