Skip to content

ming-suhi/LaTex-Notes-Template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📘 Notes LaTeX Class

A clean, printer-friendly LaTeX class for writing course notes on A5 paper. Designed with a simple, elegant style and a recommended multi-file structure. Check out documentation.pdf which serves as a sample and an in-depth guide.

Sample Notes Layout

✨ Features

  • A5 paper layout with wide outer margins (binder-friendly).
  • Customizable headers (course name + course code).
  • Clean section formatting.
  • Theorem environments (theorem, definition, lemma, example, etc.).
  • Printer-friendly white backgrounds.
  • Recommended multi-file workflow (organize content in sections/).

📂 Suggested Project Structure

notes-template/
├── notes.cls        # The class file
├── main.tex         # Entry point for your notes
├── sections/        # Note content (recommended split by lecture/chapter)
│   ├── 1.tex
│   ├── 2.tex
│   └── ...
├── images/          # Figures and diagrams (optional)

🚀 Usage

  1. Place notes.cls in your project folder.
  2. Create a sections/ folder for your note files.
  3. Use this main.tex:
% Sample main.tex
% Minimal example using the notes.cls template

\documentclass[course={Sample Course},code={Code 101}]{notes}

\begin{document}
% Best practice: keep each section in a separate file
% All section files go into the "sections/" directory.

\input{sections/1.tex}
\newpage
\input{sections/2.tex}

% Add more sections as needed:
% \input{sections/3.tex}
\end{document}

👉 The multi-file structure is recommended for clarity, but you can also write everything directly in main.tex if you prefer.


⚙️ Options

Option Default Description
course Course Notes Running header (odd pages, left)
code Math 1xx Running header (even pages, right)

📖 Theorem Environments

Available environments (numbered by section):

  • theorem
  • definition
  • corollary
  • lemma
  • proposition
  • remark
  • example
  • notation
  • fact

Example:

\begin{theorem}
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
\end{theorem}

🎨 Figures

All images can go in the images/ folder. Example:

\begin{figure}[H]
    \centering
    \includegraphics[width=0.8\linewidth]{example.png}
    \caption*{An example figure.}
\end{figure}

📜 License

MIT License — free to use and modify.

About

A clean, minimalist LaTeX class designed for creating elegant and printer-friendly course notes on A5 paper.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages