https://github.com/corymccartan/cmc-article

Lightweight and customizable Quarto article format

https://github.com/corymccartan/cmc-article

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.9%) to scientific vocabulary

Keywords

arxiv latex quarto quarto-extension quarto-template r tex
Last synced: 5 months ago · JSON representation

Repository

Lightweight and customizable Quarto article format

Basic Info
  • Host: GitHub
  • Owner: CoryMcCartan
  • Language: TeX
  • Default Branch: main
  • Homepage:
  • Size: 1.32 MB
Statistics
  • Stars: 1
  • Watchers: 4
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
arxiv latex quarto quarto-extension quarto-template r tex
Created almost 3 years ago · Last pushed 6 months ago
Metadata Files
Readme

README.md

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:

yaml format: cmc-article-pdf or

yaml format: cmc-article-typst You may want to add some of the code from header.tex in this case.

Example

Here is the source code for a minimal sample document: 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 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.

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.

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

Miscellanea

  • 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.

  • The assumptions environment is currently TeX-only.

Owner

  • Name: Cory McCartan
  • Login: CoryMcCartan
  • Kind: user
  • Company: New York University

Faculty Fellow at NYU's Center for Data Science, working on computational social science problems and open-source R software.

GitHub Events

Total
  • Issues event: 1
  • Watch event: 2
  • Push event: 4
Last Year
  • Issues event: 1
  • Watch event: 2
  • Push event: 4

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 26
  • Total Committers: 2
  • Avg Commits per committer: 13.0
  • Development Distribution Score (DDS): 0.038
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Cory McCartan c****n@g****m 25
Christopher Kenny c****4@c****u 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 3
  • Total pull requests: 1
  • Average time to close issues: 6 days
  • Average time to close pull requests: 15 minutes
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • kuriwaki (2)
  • christopherkenny (1)
Pull Request Authors
  • christopherkenny (1)
Top Labels
Issue Labels
Pull Request Labels