https://github.com/corymccartan/cmc-article
Lightweight and customizable Quarto article format
https://github.com/corymccartan/cmc-article
arxiv latex quarto quarto-extension quarto-template r tex
Last synced: about 2 months ago
JSON representation
Lightweight and customizable Quarto article format
- Host: GitHub
- URL: https://github.com/corymccartan/cmc-article
- Owner: CoryMcCartan
- Created: 2023-03-15T22:37:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-01T21:57:13.000Z (over 2 years ago)
- Last Synced: 2025-02-28T10:10:07.288Z (over 1 year ago)
- Topics: arxiv, latex, quarto, quarto-extension, quarto-template, r, tex
- Language: TeX
- Homepage:
- Size: 919 KB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `cmc-article` Quarto Format
The `cmc-article` format is designed for scholarly articles, especially preprints.
Its goal is to be lightweight yet customizable, with thoughtful typography and layout, and to support both TeX and Typst rendering engines.
Detailed word-counting functionality is also included.
## Creating a New Article
To create a new article using this format:
```bash
quarto use template CoryMcCartan/cmc-article
```
This will create a new directory with an example document that uses this format.
## Using with an Existing Document
To add this format to an existing document:
```bash
quarto add CoryMcCartan/cmc-article
```
Then, add the format to your document options: `format: cmc-article-typst` or `format: cmc-article-pdf`.
## Example
Here is the source code for a minimal sample document: [template.qmd](template.qmd).
This produces the following document (click for a full preview):
## Word Counting
During rendering a table like the following will be included in the render log.
```
WORD COUNT
-----------------------------------
Section Words Cuml.
-----------------------------------
Title 6
Abstract 163 163
(Introduction...) 609
(Formalizing ...) 1305
[further section titles and word counts]
(Conclusion ...) 158
Body 2909 3072
References 375 3447
Appendices 428 3875
-----------------------------------
```
To exclude a block element (image or table caption, div, code block) or entire
section (demarcated by a header) from any word-counting, simply add the
`{.nowords}` class to the element.
## Template Options
Most Quarto PDF options are supported here, with the primary exception of
alternative font families (see below for font customization).
Additional package-specific options are described below.
### Blinded versions
Provide the following key under `cmc-article-pdf` to produce a blinded version of the article.
```yaml
journal:
blinded: true
```
### Running header
By default, the running header will include the article title.
It can be overriden by providing your own `title-meta`.
### Fonts
#### Serif font
The default serif font is Cochineal, based on Crimson (for TeX, specifically the `cochineal` package).
If you would rather not use this font, either for file size or aesthetic reasons, you can provide the following flag.
Palatino will be used instead for the body text and mathematics.
Palatino is the only option when `pdf-engine: xelatex` is used (the default is `pdflatex`).
```yaml
font-serif-crimson: false
```
For Typst, you will need to download and install the Crimson font [here](https://fontesk.com/download/35892/).
#### Sans-serif font
The default sans-serif font is Biolinum, part of the Linux Libertine family.
If you would rather not use this font, either for file size or aesthetic reasons, you can provide the following flag.
Helvetica will be used instead.
```yaml
font-sans-biolinum: false
```
For Typst, you will need to download and install the Biolinum font [here](https://dl.dafont.com/dl/?f=linux_biolinum).
#### Serif title headings
By default, the title and section headings are set in a sans-serif font.
Provide the following key under `cmc-article-pdf` to use a serif font:
```yaml
font-headings-sans: true
```
## Switching between Typst and TeX
- If you need compatibility between Typst and TeX formats, and you are using the
`\vb` macro, you should use `\vbg` for Greek letters rather than `\vb*`, since
the latter will not work in Typst.
- The Typst template uses `citeproc: true` so that references are placed
consistently with TeX. You may need to provide your own `.csl` file if the
default format does not suit your needs. You can set `citeproc: false`
explicitly to opt in to Typst's bibliography system.
- `macros.tex` contains shared macro definitions that are available in both TeX and Typst.
To make this file work with both engines, no comments are allowed.
Some TeX-specific macros are in `header.tex`, which can be deleted if only Typst is being used.
- When switching to TeX, add `include-in-header: header.tex` to your format options.
When switching to Typst, remove this line.