8. Publishing Textbook

OPE utilizes GitHub Pages to allow you to easily deploy your website for free.

First, make sure in the xx_config.yml files that the URL, path to book, and branch are all correct. An example for this textbook is:

repository:
  url: https://github.com/IsaiahStapleton/ope-docubook
  path_to_book: content
  branch: main

Run the following command in the same directory as the Makefile in order to publish the textbook, lecture notes, and lab manual:

make pub

You may also run this command to only publish certain materials, such as if you only wanted to publish the textbook (remember that xx is referring to tb, ln, lm):

make pub-xx

After this has been done, there will be a new branch titled ‘gh-pages’ within your repository. Go to settings -> pages and make sure the branch you are deploying GitHub pages from is the gh-pages branch. At the top of the page it will give you the URL of where the site is live. If you go to that link you may see a 404 error, that is because at the end of the URL you must add /textbook, /lecturenotes, or /labmanual to view each one respectively.