janishutz/latex
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs (mostly), fixes, etc
Some checks failed
Update docs / build_docs (push) Has been cancelled
Details
Update helpers / build_helpers (push) Successful in 25s
Details

Browse Source
This commit is contained in:
Janis Hutz
2026-02-21 16:24:21 +01:00
parent 2a592753bf
commit baebaa99d0
45 changed files with 1038 additions and 691 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
docs/docs.tex
View File

@@ -1,76 +1,58 @@
\documentclass{article}
\usepackage{janishutz-helpers}
\input{../janishutz-helpers.tex}
\setup{Docs - \LaTeX \hspace{0mm} helpers}
\begin{document}
\startDocument
\usetcolorboxes
\vspace{4cm}
% ── Title page ──────────────────────────────────────────────────────
\vspace{2cm}
\begin{center}
\includegraphics[width=0.5\linewidth]{../assets/logo.jpg}
\end{center}
\vspace{5cm}
\begin{center}
\begin{Large}
\textsc{Usage guide for Version 2.0.0}
\end{Large}
\hlurl{https://git.janishutz.com/janishutz/latex}
\end{center}
% ── Table of contents ───────────────────────────────────────────────
\newpage
\printtoc{Aquamarine}
\newpage
\section{Introduction}
This set of \LaTeX files is designed to give you a good looking, pre-configured \LaTeX setup, which helps you get started much more quickly.
It has some configuration options already, but more are to come soon. If you have any suggestions as to what should be added, don't hesitate to open a support ticket at \url{https://support.janishutz.com?a=add} or contacting me via email to \texttt{development@janishutz.com}.
\section{Breaking Changes}
Please note that the regex provided below are for NeoVim and you may need to replace \verb|\(\)| with \verb|()|
\subsection{Time complexity}
The timecomplexity commands have been updated to require math environment. You can use the following regex to fix them
\verb|/ \\tc\([olt]\){\(.*)}\([, .\n]\)/ \$\\tc\1{\2}\$\3/g| (execute first)\\
and \verb|/\\text{\\tc\([olt]\){\(.*\)}}/\\tc\1{\2}/g|
\subsection{Labels \& Environments}
The counter environments can now be referenced (see \ref{sec:counters}).
Due to the new requirements set out by that addition, it is now no longer possible to manually update the counters using
\verb|\setcounter|.
Use the below regex to replace all occurrences of \verb|\setcounter| with the new format.
Please note that this will overwrite \textit{all} occurrences of \verb|\setcounter| with the specific old format with \verb|\setLabelNumber|:
\verb|/\\setcounter{\(.*\)s}/\\setLabelNumber{\1}/g| and \verb|/\\setcounter{all}/\\setLabelNumber{all}/g|
and for the \verb|\stepcounter| as well
\verb|/\\stepcounter{\(.*\)s}/\\stepLabelNumber{\1}| and \verb|/\\stepcounter{all}/\\stepLabelNumber{all}/g|.
\section{Installation}
You can install these helper files by downloading this repo and storing it to any location on your PC, remembering where that location is.
You may also install the VSCode snippets found in the vscode-snippets folder. These snippets provide autocompletion for many of the commands that this helper file provides.
\input{./parts/usage.tex}
\input{./parts/custom-loader.tex}
% ┌ ┐
% │ Reference │
% │ Imports │
% └ ┘
\input{./parts/intro.tex}
\input{./parts/usage.tex}
% ── Reference ───────────────────────────────────────────────────────
\input{./parts/reference/intro.tex}
\input{./parts/reference/loading.tex}
\input{./parts/reference/math.tex}
\input{./parts/reference/cs.tex}
\input{./parts/reference/style/intro.tex}
\input{./parts/reference/style/spacing.tex}
\input{./parts/reference/style/tcolorbox/default.tex}
\input{./parts/reference/style/tcolorbox/counter.tex}
\input{./parts/reference/style/tcolorbox/other.tex}
\input{./parts/reference/style/descriptors.tex}
\input{./parts/reference/tables-index.tex}
\input{./parts/reference/extras.tex}
\input{./parts/troubleshooting.tex}
% \input{./parts/reference/extras.tex}
%
%
% \input{./parts/troubleshooting.tex}
\end{document}