Open Source Ecosystems

About The Project

Do you want to take organized and good-looking class notes? NoTeX is a LaTeX template that makes it easy to take notes in class. It's designed to be easy to use and to look great. It's also easy to customize to your liking and allows you to take advantage of LaTeX's powerful features. This template is designed to be used with the LaTeX typesetting system. It's a great way to take notes in class and keep them organized since it take advantage of latex's subfiles package in order to keep lecture notes and images in separate files, avoiding the common problem of having a single large file that is hard to navigate. Preamble setting also follows this philosophy: different settings are placed in easy-to-find separate files, so you can easily change the look of your notes without having to dig through thousands of preamble lines. The general structure of the template is as follows:

.
├── 📔 bibliography.bib   # Bibliography file
├── 📄 main.tex           # Main document file
├── 📂 images             # Images folder
│   └── image.png
├── 📂 sections           # Sections folder
│   ├── introduction.tex
│   ├── section.tex
│   └── ...
├── 📂 settings           # Settings folder
│   └── ...
└── 📂 utils              # Utilities
    └── ...

You will find then implemented NoTeX cls class and attached sty files in the settings/ folder. This repository also provides a few uselful utility scripts in the utils/ folder that will be updated with time. These might be helpful for stuff like cleaning up or collecting data from the tex files... Notice however that they are still a work in progress so check them out before blindly run them!

Built With

Getting Started

Simply download this directory, open the main.tex file in your LaTeX editor, start a document with the notex document class as shown below and you're mostly ready to go.

\documentclass{settings/notex}

You can start your notes from the main.tex file by linking sections as shown in the example provided and add new sections in the sections/ folder. If you change directories or file names, make sure to update the tex files accordingly.

Prerequisites

[!WARNING] This template requires LuaLaTeX to be compiled correctly. If you are using Overleaf, you can change the compiler in the settings. If you are using a local LaTeX editor, you may need to install LuaLaTeX.

This template also uses the fontawesome5 package for icons. Other used packages can be found in the cls and sty files in the settings/ folder.

If you want to use this template without following these prerequisites, you might (or might not, depends...) be successful by simply commenting the unwanted packages in the settings/ folder.

Installation

Download this folder
Open the main.tex file in your LaTeX editor
Start taking beautiful notes!

Usage

This template offers multiple macros and environments to keep you note organized and good-looking. You can find a detailed guide on how to use them together with some examples in the main.tex file and in the relative sections/ files. Among the many features this template offers, it's worth mentioning the followings:

code blocks and syntax highlighting
definitions and theorems boxes
example boxes
info and warning boxes
tikz pictures support
and many more...

The settings/ folder contains the settings for the template. These include packages imports and environments definition. More importantly, all the settings in the notex.cls class file have been extensively commented to allow for user personalization.

[!NOTE] The template by default is set to a dark template but you can easily change to a light theme.

The template comes infact in a default dark theme color but all the colors are personalizable by modifying the color palettes in the notex.cls class file. Notice however that it has been implemented a default light theme if that suits your needs better. To use a light template you can just start your document with the light option as shown below:

\documentclass[light]{settings/notex}

Otherwise using the dark option will set the default dark theme.

\documentclass[dark]{settings/notex}

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!