pat-alt / quarto-juliacon-proceedings

A Quarto extension for the JuliaCon Proceedings journal.
7 stars 0 forks source link

Quarto for JuliaCon Proceedings

Build Status

This is a template for writing a JuliaCon Proceedings article in Quarto. This is a proof-of-concept for how we could use Quarto for JuliaCon proceedings. For current submissions, please ignore this repo and follow the official instructions here.

About this template

This template is based on the existing JuliaCon Proceedings LaTeX template. The rendered versions can be found here: pdf, html.

More Examples

This website contains additional example articles and information about related Quarto extensions. Currently, it contains a Quarto version of my JuliaCon Proceedings paper Explaining Black-Box Models through Counterfactuals.

PDF

The rendered PDF serves as a comparison to the published version of the paper. The remaining differences in formatting need to be sorted out here. If you notice any differences, please open an issue.

HTML

Quarto documents can be rendered to multiple output formats, which allows us to produce both PDF and HTML versions of papers from the same source document. The HTML version of the paper is fully themed in Julia colors and fonts. Contrary to PDF, it supports animated and interactive content.

Usage

[!WARNING] This is a proof-of-concept for how we could use Quarto for JuliaCon proceedings. For current submissions, please ignore this repo and follow the official instructions here.

To use this extension, you can create a new project as follows:

quarto use template pat-alt/quarto-juliacon-proceedings

Alternatively, you can add the extension to an existing project:

quarto add pat-alt/quarto-juliacon-proceedings

Then, add the format to your document options:

format:
  juliacon-proceedings-pdf: default

Finally, you can also update and remove the extension as follows:

quarto update pat-alt/quarto-juliacon-proceedings     # update
quarto remove pat-alt/juliacon-proceedings     # remove

What is Quarto?

Quarto makes it easy to write reproducible documents that can be rendered to PDF, HTML, Word and more. It is based on Markdown, which is easy to learn and write. It also supports LaTeX, which is useful for more advanced formatting. As this extension demonstrates, Quarto is also very flexible and can be extended with custom templates and styles.

Why Quarto?

By embracing Quarto, JuliaCon Proceedings can set an example for how to write reproducible documents. We would not only make it easier for authors to write their submissions but also open the door for more advanced features such as interactive figures and executable code blocks in HTML documents.