Introduction to SAS for Incoming Predocs

This is a simple website built to serve as a SAS guide for incoming predocs. It is built using Jupyter Books and hosted using Netlify. Jupyter Books turns Jupyter Notebooks (which rely on Python) and markdown files into websites that are structured as books.

Adding & Modifying Content

The Jupyter Book guide has a great tutorial about how Jupyter Books work. We will briefly go over how to add/modify content here.

Modifying Content

All of the content for our website is stored at the top level of this directory. Markdown and Jupyter Notebooks are stored within folders (representing chapters or sections) except for intro.md. To modify an already existing page, simply edit the corresponding markdown or Jupyter Notebook.

Adding Content

There are two steps to adding content

• Create the corresponding markdown file or Jupyter Notebook
• Add a line in the _toc.yml file so Jupyter Books knows where this content should go

The first step is to simply save your markdown file or Jupyter Notebook in the relevent location. To add my_new_file.md to the website, you would add the following line to _toc.yml

- file: my_new_file.md

Incorporating the Changes

Once you've added your markdown/Jupyter Notebook file and updated the _toc.yml file or modified an already existing markdown/Jupyter Notebook, you need to "re-build" the Jupyter Book to incorporate your changes into the website's html files. To do this simply run

jupyter-book build cen-sas-intro

from the command line. This will rebuild the html files with your changes. Once you have re-built the Jupyter Book all you have to do is push your changes to the master branch and Netlify will detect this update and refresh the site.