Skip to content

make4all/accessibility-classes

 
 

Repository files navigation

layout title nav_exclude permalink seo
home
Accessibility Class, based on Just the Class
true
/:path/
type name
Course
Accessibility Class, based on Just the Class

Accessibility Class

Accessibility Class is content and a structure based on Just the Class, which is a GitHub Pages template developed for the purpose of quickly deploying course websites. In addition to serving plain web pages and files, it provides a boilerplate for:

Just the Class is a template that extends the popular Just the Docs theme, which provides a robust and thoroughly-tested foundation for your website. Just the Docs include features such as:

Getting Started

Getting started with Just the Class is simple.

  1. Create a new repository based on Just the Class.
  2. Update _config.yml and README.md with your course information. Be sure to update the url and baseurl.
  3. Configure a publishing source for GitHub Pages. Your course website is now live!
  4. Edit and create .md Markdown files to add more content pages.

Just the Class has been used by instructors at Stanford University (CS 161), UC Berkeley (Data 100), UC Santa Barbara (CSW8), Northeastern University (CS4530/5500), and Carnegie Mellon University (17-450/17-950). Share your course website and find more examples in the show and tell discussion!

Local development environment

Just the Class requires no special Jekyll plugins and can run on GitHub Pages' standard Jekyll compiler. To setup a local development environment, clone your template repository and follow the GitHub Docs on Testing your GitHub Pages site locally with Jekyll.

Just the Class does not work with custom plugins

If you have any trouble installing Ruby or Jekyll on a Mac, there are great resources at Ruby on Mac

Todos

Consider adding to Reveal:

Consider adding support for generating things using pandoc and so on in cli e.g. this reveal advice or what's recommended here about scientific computing

About

A modern, highly customizable, responsive Jekyll template for course websites.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 96.8%
  • SCSS 1.7%
  • Other 1.5%