The goal of this quarto extension is to provide a wide range of quarto-based formats for INRAE engineers and researchers. These are an unofficial and opiniated templates.
- The {InraeThemes} R package for ggplot2 and bootstrap themes
- The inrae-project-website extension for research project website templates
To make the full use of these templates, you will need :
- 2 fonts defined in INRAE's design system :
Raleway
andAvenir Next Pro Cn
that can be downloaded here - A LaTeX installation if you are using the
beamer
format - Of course, Quarto installed (> 1.4.0)
You will need to do this to get all the folders with all the templates, assets and prefilled quarto templates :
quarto use template davidcarayon/quarto-inrae-extension
Note: Previous versions of this extension can still be downloaded using GitHub release tags :
quarto use template davidcarayon/[email protected]
You may also use this format with an existing project to download only the _extensions
folder (not recommended).
quarto add davidcarayon/quarto-inrae-extension
You can use the any of the template_*.qmd
templates which all have an inrae-*
format pre-configured.
You will also find a _quarto.yml
file to use if you want to use custom projects (manuscripts, websites, books). These projects will use the index.qmd
file.
Of course, this extension offers more features than you will typically need, so you can delete all the unnecessary qmd files.
These formats and designs are opiniated. Feel free to modify them to suit your needs in _extensions/davidcarayon/inrae
. All suggestions and PR's are warmly welcomed.
To customise your formats, see the relevant documentations :
- Html and office documents (html/revealjs/docx/pptx) : Quarto's documentation
- Typst documents (pdf) : Typst's documentation
- LaTeX documents (beamer) : LaTeX's Beamer documentation
- Quarto projects (manuscript, website, book) : Quarto's documentation
inrae-html
: Provides an html document that can be hosted online (quarto-pub, github/lab pages, etc.). See Publishing in Quarto's documentationinrae-typst
: Generates a PDF document using the Typst engine, a new open-source markup-based typesetting system that is designed to be as powerful as LaTeX while being much easier to learn and use.inrae-docx
: Generates a word document, typically to share for revisions
inrae-revealjs
: Generates HTML slides that can be hosted online (quarto-pub, github/lab pages, etc.). See Publishing in Quarto's documentationinrae-beamer
: Generates PDF beamer slides using LaTeXinrae-pptx
: Generates a Powerpoint presentation, typically to... whatever.
NB : Some obscure error may occur when rendering Beamer if you are using 2023's version of texlive. If so, I can only suggest to follow this article to try and go back to 2022's version.
If you wish to use one of the 3 project formats, you can edit the _extensions/davidcarayon/inrae/_extension.yml
to comment/uncomment your desired output :
## Project definition
project:
project:
type: default
#type: website
#type: manuscript
#type: book
format: inrae-html
manuscript
: Quarto manuscript projects provide a framework for writing and publishing scholarly articles. See more herewebsite
: Quarto Websites are a convenient way to publish groups of documents. They can also be used as easy to deploy research project websites. See more herebook
: Quarto Books are combinations of multiple documents (chapters) into a single manuscript while not breaking cross-references. They can be typically used for complex reports. See more here
- RevealJS presentation of the SK8 project (FR) : slides and code
- RevealJS presentation prepared for a training on phylogenetic methods : slides
- Quarto website filled with html docs and revealjs slides, all based on this extension, with a few tweaks : documents.migale.inrae.fr
- Cleaned the extension file tree
- new Typst format to replace the laggy LaTeX format for PDF reports
- Better documentation
- New feature : Projects (Manuscripts / websites / books)