https://github.com/lunacookies/polytextum

Generate articles and reports from markdown files using pandoc and LaTeX
https://github.com/lunacookies/polytextum

latex-template markdown pandoc typography

Last synced: about 2 months ago
JSON representation

Generate articles and reports from markdown files using pandoc and LaTeX

• Host: GitHub
• URL: https://github.com/lunacookies/polytextum
• Owner: lunacookies
• License: isc
• Archived: true
• Created: 2018-08-11T22:39:42.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-17T01:32:03.000Z (over 5 years ago)
• Last Synced: 2024-10-15T12:03:16.779Z (2 months ago)
• Topics: latex-template, markdown, pandoc, typography
• Language: TeX
• Homepage:
• Size: 104 KB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Polytextum

Generate articles and reports from markdown files using Pandoc and LaTeX.

## A note on fonts

The fonts used throughout Polytextum are not included. To use Polytextum, you

must sync the required fonts from [Adobe Fonts](https://fonts.adobe.com).

Make sure you have successfully synced all styles of these fonts:

- [Minion 3](https://minion.typekit.com) ([Regular](https://fonts.adobe.com/fonts/minion-3),

  [Display](https://fonts.adobe.com/fonts/minion-3-display), [Caption](https://fonts.adobe.com/fonts/minion-3-caption), and [Subhead](https://fonts.adobe.com/fonts/minion-3-subhead))

- [Fira Mono](https://fonts.adobe.com/fonts/fira-mono)

## Quick start

1. Clone this repository to `XDG_DATA_HOME` (defaults to `$HOME/.local/share`):

       git clone https://github.com/arzg/polytextum.git ${XDG_DATA_HOME:-$HOME/.local/share}/polytextum

1. Place the `polytextum` executable somewhere in your path.

1. Run `bash ${XDG_DATA_HOME:-$HOME/.local/share}/polytextum/scripts/link.sh` to link all the necessary files into place

1. Run `bash ${XDG_DATA_HOME:-$HOME/.local/share}/polytextum/scripts/installfonts.sh` to copy all of Adobe Fonts’ files

   into a cache

1. Start using Polytextum!

## Usage

To run Polytextum on a given markdown file run

    pt article yourfile.md

for an article, and this

    pt report yourfile.md

for a report.

Note that the difference between a report and an article is that articles can

have two levels of headings, and that reports can have three (the top level is

turned into a chapter). Reports also have title pages and tables of contents.