Skip to content

Latest commit

 

History

History
85 lines (51 loc) · 1.44 KB

README.md

File metadata and controls

85 lines (51 loc) · 1.44 KB
title author toc type layout theme links-as-notes header-includes
Intro to CS Course Website CSCI 135
rvente
true
pages
posts
metropolis
true
\usetheme{metropolis}

Constraints

  • free hosting

  • no fine print

  • familiar

  • easy to maintain

  • mobile friendly

  • Screen-Reader Friendly (accessibility)

Solutions

Github-centered Workflow

  • GitHub Pages

  • GitHub Markdown

  • Open Source

GitHub Markdown

  • superset of HTML

  • reduces our maintenence complexity

Inter-Op

  • Losslessly convert between HTML and Markdown using Pandoc

Maintenence

  • _posts/labs/ stores the labs

  • _posts/readings/ stores the readings

  • etc...

  • Push to master...

  • Everything autopopulates in 5 minutes or less.

Demo

Development

Dependencies

  • Install ruby,ruby-bundler, and nodejs. on Ubuntu sudo apt install ruby-dev ruby-bundler nodejs. On Arch, sudo pacman -S ruby ruby-bundler nodejs.

Local Deployment

Then, intitialize the local development environment using

  • bundle clean (no --force)

  • bundle install

  • bundle exec jekyll serve

  • Visit localhost:4000 to see the site on your local server. Kill the server using CTRL+C in the appropriate terminal.

Additional Documentation