Code Monkey home page Code Monkey logo

open-textbooks's Introduction

Open Textbooks with Quarto and GitHub

In this repository we are working on an open textbook about creating open textbooks in Quarto, which is then hosted on GitHub pages.

Work In Progress!

License

The open textbooks book is licensed under a CC-BY 4.0 license.

Maintenance

This book is being maintained by RDM Support and Education Support at Utrecht University.

open-textbooks's People

Contributors

dorienhuijser avatar

Stargazers

 avatar  avatar

Forkers

owain-s

open-textbooks's Issues

GitHub actions workflow

Add as a chapter, to reduce manual work re-building the site every time a change is made. And maybe for other things? :)

Potential chapters and ideas

Issue originally opened by @nehamoopen

I would consider following the chapter structure from rstudio4edu for bookdown books and tailor it for ourselves also considering our approach in the Reproducible Manuscripts workshop:

  • Introduction
  • Make A Book
  • Make It Yours
  • Caring For Your Book
  • Dress It Up
  • Make It Fancier

Followed by:

More specifically (in no specfic order):

  • Build a Quarto book
  • Write in Markdown
  • Embedding different types of content (images, videos, slides, documents)
  • Cite / Bibliography Management using Zotero
  • Structuring Parts / Chapters / Subchapters in TOC
  • Rendering to HTML / pdf / docx
  • Integrating with GitHub (initial + maintenance workflow)
  • Deploying with GitHub Pages
  • Automating Rendering with GitHub Actions
  • Integrating with Zenodo for FAIRification
  • Basic theme customization with CSS / HTML
  • Interactivity with webexercises and learnr
  • HTML interactivity with drop-down sections etc.

I think all of this is now included in the skeleton but opening this issue anyhow

EduSlides - provide more context

  • When to use this solution, and when not to?
  • Comparison with the other open textbooks solution?
  • Maybe give some examples of nice Quarto / online books hosted on GH pages?

EduSlides - content check

I've updated the structure of the workshop a bit, also based on some feedback from Neha. Now git is not mentioned anywhere before the first break, but the Markdown section is shortened a lot and put in the first section instead. The slides with the writing hand ✍️ indicate practical work/exercises, but for some exercises the instructions are really long. Not sure if that's an issue, but if you have ideas to either change/improve the exercises, move them, or remove them, feel free to change it. An entire content check from you both would be nice so that we're all on the same page!

EduSlides - move to nehamoopen/let-git-started?

As this current repository is meant for the open-textbooks book, and the nehamoopen/lets-git-started repo was made solely for EduSupport's learning journey, perhaps that would be a better location to put the slides for the Education Support workshop. In that case the slides can also be rendered with GitHub pages so they are available online.

I currently don't have writing access to that repo, and neither does Kim. If we decide to do this it would be great if we got it in case of last-minute changes.

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.