This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
This site is built with Jekyll. Find the docs here
-
Clone the repo
git clone git@github.com:turingschool/backend-curriculum-site.git
-
run
bundle install
-
You can now begin to edit the website.
-
To start the server run
jekyll serve --incremental
. -
Navigate to
localhost:4000
to see the site -
make changes on the
gh-pages
branch. -
you can push changes to production by pushing the
gh-pages
branch 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
.
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.
Put something like this at the top of all your markdown files:
---
title: Name of lesson
subheading: lesson is about stuff
layout: page
---
subheading
is optionallayout
is basically always going to bepage
The system we're using to translate from github to backend.turing.edu uses index files instead of readme files. Where you would have created a file called readme.md
, just use index.md
instead
When linking to a markdown file, drop the .md
in your link. Instead of linking to learning_to_pair.md
, just use learning_to_pair
. Other files, like PDFs and PNGs, keep the original extension.
Since you're editing on github, and viewing at backend.turing.edu, you'll probably want to use relative links instead of absolute links. I found a primer on the difference. It's in the context of HTML instead of Markdown, but should basically explain the concept: http://www.boogiejack.com/server_paths.html
Github uses a slightly different system for translating from Markdown than the engine we use for backend.turing.edu. Here's some things that I had to change to get things to look right on the site, even if it looks right on Github.
- Put a space after your
#
's in headers - Put a blank line between your headers and any content below
- Replace any
|
with\|
unless you're really trying to do a table