Understanding the Course Template


Screenshot of the course template in GitHub


Once you’ve forked the course, you’ll see the course’s guts as a list of folders and file names. This list contains all of the learning content for the course as well as the code that holds it all together. This guide will always tell you exactly where to look to update different parts of your course, so you don’t need to read or memorize this section in order to proceed.


Directory layout explanation

πŸ“ _data - course metadata 
πŸ“ _includes - html for page components
πŸ“ _layouts - html for various page layouts
πŸ“ _sass - styling code
πŸ“ css - more styling code
πŸ“ fonts - font files (including icons!)
πŸ“ img - image files
πŸ“ js - JavaScript for interactive components of the site
πŸ“ modules - folder for the actual course content
.gitignore - a git file (for keeping this directory tidy)
404.html - error text that appears on broken links or nonexistent pages
CNAME - use for setting custom domains
Gemfile - used by jekyll/GitHub pages
LICENSE - Course-in-a-Box is licensed under the MIT License (do not edit)
README.md - a text file to introduce and explain the project
_config.yml - Jekyll/GitHub pages configuration & settings
index.md - landing page content
single-page.md - an example single page of content

Previous submodule: