Skip to content

numpex/presentation.template

Repository files navigation

A Beamer Template for NumPEx Presentations

DOI GitHub Release PyPI - article-cli Slack Slack

Getting Started

This template uses article-cli for project management.

Installation

pip install article-cli

Quick Start

Clone the repository and add the path to your TEXINPUTS environment variable, then use the theme in your presentation:

\usetheme{numpex}

Slides Template

Compile presentation.template.tex:

article-cli compile --engine xelatex presentation.template.tex

Poster Template

Compile poster.template.tex:

article-cli compile --engine xelatex poster.template.tex

Fonts

For the best result, you should install the Marianne font and compile with XeLaTeX.

Installing Fonts

Install the required fonts (Marianne and Roboto) using article-cli:

article-cli install-fonts

This downloads and extracts the fonts into the fonts/ directory within your project. The beamerfontthemenumpex package is already configured to use fonts from this relative path.

Manual Font Configuration

If you prefer manual installation, ensure your LaTeX configuration points to the fonts/ directory.

Using This Theme in Other Projects

You can install this theme in any LaTeX project using article-cli:

# Install the numpex theme (default)
article-cli install-theme numpex

# Or install from a custom URL
article-cli install-theme --url https://github.com/numpex/presentation.template.d/archive/refs/heads/main.zip

# List available themes
article-cli install-theme --list

CI/CD Pipeline

This repository includes a GitHub Actions workflow that uses article-cli to compile LaTeX documents and create releases. The workflow is triggered on pushes to branches and tags.

Workflow Steps

  1. Setup: Installs Python and article-cli
  2. Install Fonts: Downloads required fonts using article-cli install-fonts
  3. Build LaTeX: Compiles documents using XeLaTeX via article-cli compile
  4. Release: Creates GitHub releases for tagged commits (e.g., v1.0.0)

Usage

Setup Project

article-cli setup

Compile Documents

# Compile with XeLaTeX (required for custom fonts)
article-cli compile --engine xelatex presentation.template.tex

# Compile all .tex files in the project
article-cli compile --engine xelatex

Create a Release

article-cli create v1.0.0

List Releases

article-cli list

Clean Build Artifacts

article-cli clean

Configuration

Project settings are managed in pyproject.toml:

[tool.article-cli]
[project]
type = "presentation"

[latex]
engine = "xelatex"

[fonts]
enabled = true
install_dir = "fonts"

Legacy Script

The old a.cli bash script is still available for backward compatibility but is deprecated. Please migrate to article-cli for new projects.

Contributing

Feel free to open issues or submit pull requests for improvements or bug fixes.

License

This project is licensed under the MIT License. See the LICENSE file for details.


About

This repository contains latex templates for NumPEx documents

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •