Skip to content

BarnabasRobotics/Barnabas-Instructors-Guide

 
 

Repository files navigation

Welcome to GitHub Pages

You can use the editor on GitHub to maintain and preview the content for your website in Markdown files.

Whenever you commit to this repository, GitHub Pages will run Jekyll to rebuild the pages in your site, from the content in your Markdown files.

Markdown

Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for

Syntax highlighted code block

# Header 1
## Header 2
### Header 3

- Bulleted
- List

1. Numbered
2. List

**Bold** and _Italic_ and `Code` text

[Link](url) and ![Image](src)

Switch between text-based and block-based

Block-based Image:

![fig 3.6](fig-3_6.png){:.image .block-based}

General tag:

  • {:.text-based}
  • {:.block-based}

YouTube: {% include youtube.html id='YOUTUBEID' %}

For more details see GitHub Flavored Markdown.

Jekyll Themes

Your Pages site will use the layout and styles from the Jekyll theme you have selected in your repository settings. The name of this theme is saved in the Jekyll _config.yml configuration file.

Support or Contact

Having trouble with Pages? Check out our documentation or contact support and we’ll help you sort it out.

Image Recommendations

In the Barnabas docs the lesson images are stored in their respective lesson folder. All other site images are stored under assets. This is subject to change to a library as many of the images will be used in other cirriculum. All images should be no larger than 640 pixels wide and preferrably in png format. A service like tinyPNG can also compress these images based on color depth while preserving transparent backgrounds. A compressed file improves site delivery and puts less load on mobile devices.

Adding New Lessons

To add new lessons, the following files need to be updated:

  1. _config.yml - deterimines the files to load
  2. index.html - home page
  3. /_includes/sidebar/lessonsegment.html - show lesson in the sidebar
  4. /_includes/sidebar/menu.html - show lesson in the sidebar
  5. /_layouts/lesson.html - lesson page layout

Icons

Side menu icons reference Font Awesome: https://fontawesome.com/v4.7.0/icons/

Revision History

  • 1.00

Releases

No releases published

Packages

No packages published

Languages

  • SCSS 41.3%
  • CSS 30.7%
  • HTML 17.2%
  • JavaScript 10.4%
  • Ruby 0.4%