This site is built with Jekyll. Find the docs here
-
Clone the repo
git clone [email protected]:turingschool/backend-curriculum-site.git -
run
bundle install -
You can now begin to edit the website.
-
To start the server run
jekyll serve. -
Navigate to
localhost:4000to see the site -
make changes on the
gh-pagesbranch. -
you can push changes to production by pushing the
gh-pagesbranch to github.git push origin gh-pages. -
The changes may take a minute or two to be recognized on production. Please make sure you review your changes on production.
You will find a module specific directory. eg module1 and within each directory you will find a directory for lessons and projects. All files within this site can be written as either markdown or html. To link to each you just need to write the relative path to each file without the file extension. For example lessons/lesson_on_stuff.
Additionally each new file will need a header:
---
title: Name of lesson
subheading: lesson is about stuff
layout: page
---The navigation.html file is where you will find the sidebar for the site.
The today.html file is where you will find the basic html page for today, and each file for the specific day will live within the today directory.