This repo contains LaTeX packages that define custom styles and commands that can be used when writing notes in LaTeX, or an assignment.
There are two ways to use these files:
- Add them directly to the project directory that contains the
tex
files being worked on. This requires importing them in a slightly different way — the normal way works, but sometimes it will complain on compiling.\usepackage{./notestyles}
- Add them to your
texmf
directory. On Windows, using MiKTex, you can add a custom directory to yourtexmf
root directories, by openingMiKTex Console > Settings > Directories
, and then adding a path there. I recommend making a directory at~\texmf
, set withGeneric
purposes. Inside that directory, the path needs to betex\latex\custom
, butcustom
can be replaced with whatever name you want to give the folder. After that, they can be imported into a LaTeX file asAdding the files to your\usepackage{notestyles}
texmf
directory has the added benefit of allowing LSPs such as texlab, and tools such as vimtex (if you use Vim or Neovim), to find the added commands and environments, which aids in autocomplete.
TeX packages that have been used are:
- amsmath, amssymb: Used for mathematical symbols and environments
- amsthm: Used for the proof environment
- babel: Use description environment, and chapter renaming
- caption: Allow captions in non-floating environments
- changepage: Allow paragraphs to be indented
- enumitem: Used to improve the way lists are displayed
- etoolbox: Allow commands to be patched
- fancyhdr: Improve header and footer display
- fontenc, charter, inconsolata, cabin, newtxmath, bm: Font display
- geometry: Used for document margins
- graphicx: Import images into LaTeX
- hyperref: Add PDF bookmarks
- parskip: Set proper default values for paragraph separation
- subfiles: Allow
tex
files to be written separately, but built together - tabularray: Better table display and management.
- tcolorbox, adjustbox: Create colored boxes for different environments
- tikz: Construct images using LaTeX
- wrapfig: Used to allow text to wrap around figures
- xparse: Better argument parsing for optional arguments
- xcolor: Used to get more colors
- xstring: Analyze strings given as arguments to an environment
concept{text}
: Marks specific text as a concept to be learned. Puts the text in bold.rulebookend
: Insert a decorative horizontal line at the end of the text.rulechapterend
: Insert a decorative horizontal line at the end of each chapter.
answer
: Indicates an answer to a question, normally in exercises. Unbolds the text that is made bold with the question environment.definition[args]{title}
: Creates a definition tcolorbox, with the given title. Args are optional, and are extra parameters for the tcolorbox.example[title][args]
: Creates an example tcolorbox. Both the title and args are optional, but if both are included, the title must appear before the additional arguments.% Right \begin{example}[Some Title][float] \end{example} % Wrong \begin{example}[float][Some Title] \end{example}
descriptenum
: Creates a mix of an enumerate list and a description list.descriptimize
: Creates a mix of an itemize list and a description list.exercise[args]{title}
: Creates an exercise tcolorbox, with the given title. Args are optional, and are extra parameters for the tcolorbox.indentparagraph
: Creates an indented paragraph.question
: Indicates a question to be answered, normally in exercises.sidenote[args]{title}
: Creates a sidenote tcolorbox, with the given title. Args are optional, and are extra parameters for the tcolorbox.theorem[args]{title}
: Creates a theorem tcolorbox, with the given title. Args are optional, and are extra parameters for the tcolorbox.
example color
: Used for the background in examplesexample title
: Used for the title background in examplesexample border
: Used for the border around examplesdefinition color
: Used for the background in definitionsdefinition border
: Used for the border around definitionsexercise color
: Used for the background in exercisesexercise border
: Used for the border around exercisesnote color
: Used for the background in sidenotesnote border
: Used for the border around sidenotestheorem color
: Used for the background in theoremstheorem border
: Used for the border around theorems