Git Product home page Git Product logo

ceg_rdm_handbook's Introduction

Your first TeachBook using the GitHub template

The template allows you to start your own Jupyter Book and hosting that book online without knowledge on Git, the Jupyter book package, python or anaconda. It doesn't elaborate on the collaborative functionalities of Git or how to edit the book.

  1. To get started making your Jupyter Book with our functionalities, use the template book as template:

use-template

  1. Fill in a repository name, this name will be used in the future url of your book:

create_new_repository

  1. Set source for GitHub pages to under Settings - Pages - Build and deployment - Source - GitHub Actions. As long as you don't do this your book is not published online:

Activate pages

  1. Make a edit to the book by editing one of the files in the book/ subdirectory (available under Code) or by running the workflow from Actions - All workflows - call-deploy-book - Run workflow - Run workflow. Wait a few minutes for the website to be deployed, if you're curious, you can see the progress and result under Actions - All workflows - call-deploy-book -<the most recent workflow run> (The first commit might have failed because github pages wasn't activated at the time of Initial commit):

Action

  1. When the workflow has finished, visit your build book at https://<username or organiszation_name>.github.io/<repository_name> (case sensitive). For our example it is https://dummydocent.github.io/test_book_from_template/ for the shown repository. These links are visible in the action as well, as shown in the figure above or in the GitHub repository website which you set in step 3.

Additional tip: Set the repository website as your GitHub Pages website under Code- About - - Website - Use your GitHub Pages Website

github_pages_as_website

ceg_rdm_handbook's People

Contributors

loraarmstrong avatar

Watchers

 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.