https://github.com/sandyspiers/vinyl

A latex template for the allergic
https://github.com/sandyspiers/vinyl

latex latex-template

Last synced: 21 days ago
JSON representation

A latex template for the allergic

• Host: GitHub
• URL: https://github.com/sandyspiers/vinyl
• Owner: sandyspiers
• Created: 2024-10-15T13:02:36.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-12-10T05:56:59.000Z (26 days ago)
• Last Synced: 2024-12-10T06:31:46.636Z (26 days ago)
• Topics: latex, latex-template
• Language: TeX
• Homepage:
• Size: 95.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Vinyl - A hypoallergenic latex template

Hate computer modern and 100 line preambles?

Well, this is _vinyl_, a Latex template for the allergic.

**Design Intentions**

- Typographically pleasing

- Promotes simplistic Latex code

- Requires minimal (read: _no_) extra configuration

- Scalable from small notes to large theses

**Desired Compatability**

- Compatable with all Latex compilers (**however** `lualatex` is a strong

   preference)

- Allow empty pages (to create equations alone)

- Tight and pleasant integration with Emacs org-mode with minimal extra

   configuration required

## Document Classes

This template actually provides four document classes, `empty`, `note`, `paper`

(default) and `book`. To choose a template simply add

```latex

\documentclass[note]{vinyl}

```

changing `note` to whichever you want.

- `empty`: used to produce an empty page containing only the given latex

   expression. Used to produce org-previews and the like.

- `note`: used to make short notes that get straight to the point.

- `paper`: slightly beefier than a note. Great for drafting papers.

- `thesis`: this is the real deal, the big kahuna.

Examples are each can be seen in `examples/`.

## Macros and Theorems

By default, `vinyl` loads in a personal set of macros and preferred theorem

environments, defined in `vinylmacros` and `vinyltheorems`. But you can turn

them off with the class options `nomacros` and `notheorems`.

## Installation

The easiest way to install is to simply copy the class and style files into the

directory of the file your working on. Otherwise, you can install it into your

`texmf` tree for easy use with any tex file. An example is shown in `setup`,

however this uses sym links so dont delete the original.