Skip to content

gl-eb/quarto-clean-manuscript

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Clean Manuscript

This template was designed for long-form text documents. The three formats (html, typst, docx) were not designed to be as close to eachother visually as possible. Their design was informed by partical decisions and according to the capabilities of the respective file types. The Typst template is based on my own minimal doc template and uses code written by Christopher T. Kenny for his own ctk-article template. While I use it in an academic context, it should be versatile enough for anyone to use. I tried to follow established typographic principles (e.g. in terms of line length and height) to enhance readability. Nevertheless, it is fairly opinionated and does not provide easy customization through YAML options. Feel free to fork this repository and tweak the template (while complying with the MIT license).

Installation

The following command will install the extension and create an example qmd file that you can use as a starting place for your document.

quarto use template gl-eb/quarto-clean-manuscript

Should you want to install the extension in an already existing Quarto project, use the following command:

quarto add gl-eb/quarto-clean-manuscript

Usage

---
title: Your Document Title
author: Name
date: last-modified
format:
  clean-html: default
  clean-typst: default
  clean-docx: default
---

None of the formats were designed to be easily customizable. Should you want to do so anyways, refer to the following files:

You can also try using Quarto's YAML options, but your mileage may vary since some design choices are hard coded. Refer to the HTML, Typst, and MS Word / docx guides.

Resources

The HTML format uses Adobe's Source family of fonts, which are bundled with the extension. They are licensed under the SIL Open Font License.

The docx format uses the Charter font, which comes preinstalled with macOS. You can download it from Matthew Butterick's excellent Practical Typography website

The eLife and Science citation style language styles also come bundled with this extention. Their are licenses under the Creative Commons Attribution-ShareAlike 3.0 Unported license. These two styles are author-date and numeric styles respectively.

Example

Here is the source code for a minimal sample document: template.qmd. A rendered html of the example can be found here, where you can also download the same document as Typst-rendered PDF and docx.