kjegru/NINA-ebook-template

This is a template repository for creating NINA themed bookdown project using quarto. The website is rendered using GitHub actions and hosted on GitHub Pages

NINA ebook template

Template repository for creating a NINA-themed book powered by Quarto and rendered by GitHub Actions onto GitHub Pages. The template has borrowed heavily from Jens Åström's work on the Quarto template for NINA reports. Also, thanks to Niccolò Cantù for the SCSS file with the NINA color scheme.

Note: When clicking 'Use this template', remember to copy all branches, to include the GH-pages branch. If you forget this, see the information at the bottom of this page for how to initiate GitHub actions.

Overview

The repository holds:

• .github/workflows/quarto-render.yml: Install, setup, and render a Quarto book using R and Python
• _quarto.yml: Setup the properties of the book in a minimal fashion (for more options see Quarto: Book Structure)
• index.qmd: Welcome page

Additional files:

• requirements.txt: List of Python packages to install
• DESCRIPTION: List of R packages using the standard DESCRIPTION file to install with pak.

Publishing with GitHub Actions

Included in the repository is a custom GitHub Action that will automatically render and deploy the book onto GitHub Pages. Before the first run of the GitHub Action, please make sure to use locally in terminal the following:

quarto publish gh-pages

This command initializes the gh-pages branch and turns on GitHub Pages for the repository.

If you do not run this command before the first GitHub Action is triggered, you will likely encounter the following error message in the build log:

ERROR: No _publish.yml file available (_publish.yml specifying a destination required for non-interactive publish)

To avoid this issue, please make sure to run the GitHub Action locally so that GitHub can render and publish your Quarto document after every push to the repository.