Git Product home page Git Product logo

nina-ebook-test's Introduction

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 a 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-pgaes branch. If you forget this, see the inforamtin at the bottom of this page for how to initiate GitHub actions.

Overview

The repository holds:

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.

nina-ebook-test's People

Contributors

kjegru avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.