Multi-Purpose Professional & Academic LaTeX Template

A clean, modern, and versatile LaTeX template engineered for multiple professional and academic use cases: academic papers, journal preprints, technical & engineering reports, white papers, and business proposals.

Source Repository: https://github.com/pushkarsathe89/Latex_template
Author / Maintainer: Pushkar Sathe

---

🎯 Supported Use Cases & Modes

This template includes a custom document class (custom-article.cls) that adapts layout, headers, footers, section typography, and metadata blocks seamlessly based on class options:

Mode	Class Option	Ideal For	Features
Academic	[mode=academic]	Research papers, conference submissions, preprints	Centered uppercase headings, author affiliations (authblk), running header with paper title & repository link, abstract box.
Technical Report	[mode=report]	Engineering reports, project specs, technical white papers	Left-aligned section headers, Document Control Block (Doc ID, Version, Status, Org), Executive Summary box, Revision History table.
Business Proposal	[mode=proposal]	RFPs, client proposals, strategic plans	Modern corporate styling, client metadata, key takeaway callout boxes, custom header/footer with version tracking.

Font Switch

• [font=serif] (default): Classic serif typography for formal publications.
• [font=sans]: Modern sans-serif typography (helvet) for corporate and technical documents.

---

🚀 Features

• Multi-Purpose Document Class (custom-article.cls): Instant toggle between academic paper, technical report, and proposal layouts without changing content structure.
• Document Metadata & Control: Native commands for \documentid{}, \version{}, \status{}, \organization{}, and \client{}.
• Rich Callout & Summary Blocks: Includes execsummary (Executive Summary box), callout (Key Takeaways box), and revisionhistory environment.
• Header & Footer Repository Branding: Displays running headers/footers with document metadata and automatic links back to github.com/pushkarsathe89/Latex_template.
• Modular File Layout: Separates preamble, metadata, sections (abstract, introduction, methodology, results, etc.), figures, tables, and references.
• VS Code & Overleaf Ready: Pre-configured for VS Code with LaTeX Workshop settings.
• Automated CI/CD: Includes a GitHub Actions workflow (.github/workflows/build-pdf.yml) to compile and publish PDF artifacts automatically on pushes or pull requests.

---

📁 Repository Structure

.
├── main.tex                  # Primary LaTeX file combining all modules
├── custom-article.cls        # Custom document class supporting multiple modes
├── preamble.tex              # Package imports, hyperref settings, and macros
├── references.bib            # BibTeX references file
├── LICENSE                   # MIT License
├── README.md                 # Project documentation
├── .gitignore                # Configured rules for LaTeX output files
├── .vscode/
│   └── settings.json         # Out-of-the-box VS Code + LaTeX Workshop settings
├── .github/
│   └── workflows/
│       └── build-pdf.yml     # Automated PDF build workflow
├── figures/                  # Place images/plots here (e.g., .pdf, .png, .jpg)
├── tables/                   # Place modular table code files here (optional)
└── sections/                 # Document sections
    ├── abstract.tex          # Abstract / Executive Summary content
    ├── introduction.tex
    ├── related.tex
    ├── methodology.tex
    ├── results.tex
    ├── discussion.tex
    └── conclusions.tex

---

🛠️ Getting Started

1. Using this Template on GitHub

Click the green Use this template button at the top of the repository to create your own copy without cloning full history.

Alternatively, clone the repository:

git clone https://github.com/pushkarsathe89/Latex_template.git my-project
cd my-project

2. Choosing Document Mode

In main.tex, select the document mode that fits your use case:

% For Academic Papers:
\documentclass[mode=academic,font=serif,11pt,a4paper]{custom-article}

% For Technical / Engineering Reports:
% \documentclass[mode=report,font=sans,11pt,a4paper]{custom-article}

% For Business Proposals / White Papers:
% \documentclass[mode=proposal,font=sans,11pt,a4paper]{custom-article}

3. Customizing Metadata

\title{Project Title}
\subtitle{Technical Subtitle or Scope}
\author[1]{Author Name}
\organization{Company or Institution}
\client{Client Name}
\documentid{DOC-2026-01}
\version{1.0.0}
\status{Final}

---

⚙️ Building & Compiling

Option A: VS Code (Recommended)

1. Open this repository in VS Code.
2. Install the LaTeX Workshop extension.
3. Open main.tex and press Ctrl+Alt+B (or Cmd+Option+B on macOS) to build.

Option B: Command Line (latexmk)

latexmk -pdf main.tex

To clean build artifacts:

latexmk -c

Option C: Overleaf

Upload this repository as a .zip archive or directly import from GitHub into Overleaf. Set main.tex as the main document file.

---

💳 Attribution & How to Credit

This template is free and open-source under the MIT License.

If you use or modify this template for your paper, report, or proposal, crediting the original repository is greatly appreciated! You can credit this work in any of the following ways:

1. Link back in your Repository / README

Include a link to the original template in your repository's README:

This repository is based on the [LaTeX Template](https://github.com/pushkarsathe89/Latex_template) by [Pushkar Sathe](https://github.com/pushkarsathe89).

2. Include in Document Acknowledgements

In main.tex, you can include a note in your Acknowledgements section:

\section*{Acknowledgements}
This manuscript was prepared using the LaTeX Article Template (https://github.com/pushkarsathe89/Latex_template).

3. BibTeX Citation (Optional)

@misc{sathe2026latex,
  author = {Sathe, Pushkar},
  title = {LaTeX Article Template},
  year = {2026},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/pushkarsathe89/Latex_template}}
}

---

🤝 Contributing & Feedback

Feel free to open an issue or submit a pull request on GitHub if you have suggestions, bug fixes, or enhancements to share!

---

📄 License

This project is licensed under the MIT License.