Repository files navigation

view course site

apply to participate

##Instructor Guidance

To edit / create sessions:

1. go the the sessions/YYYY/$session folder
2. theindex.html orindex.md (html vs markdown; markdown will supersedehtml, and is necessary to have the content parsed as markdown) file is themain session slides
3. the yaml header material (the content between the---s) specifies all thenecessary header and footer material for the slides (e.g., the doctype, openinghtml/head/body elements, closing elements) via the layout value
4. so to add / edit slides, just add / edit the section elements.
5. slidedemo here; more directionshere
6. for non-slide content (e.g., if you need the students to download someprepared content for an exercise), add it to this directory as well.
7. for markdown slides: we are using thekramdown engine; detailed documentation in the link

To run the site locally, install jekyll according to GH instructions, then clonethe repository. In the root of the clone, call

jekyll serve -w --config=_config.yml,_locconfig.yml

This causes jekyll to serve the site onlocalhost:4000, and reload (-w option) whenevercontent files are updated (changes to yml files will trigger the process toindicate it is reloading, butwill not actually cause those changes to be reflected).The--config flag uses the global site config data, but overrides the relevanturl variables with the_locconfig.yml file.

If on a system with bash scripting available (typical *nix system, Windows withPowerbash or the like installed), you may simply use the script./run.sh toserve the site.

Notes on making session slides:

• if you use<section markdown="block"> for slides +.md instead of.htmlextension,markdown syntax should just work.
• may need to wary of mixing that with code highlighting
• if you use<aside> ... </aside>, you can write notes
• the notes may also use markdown, if you add themarkdown="block" attributeto the aside element.

##Kramdown Referenceavailablehere

##Integrated "Theme" Referenceavailablehere

##Doing Site Editing w/ AtomTheatom.io editor is pretty great. You can use atom for jekylldevelopment in a convenient way:

1. open a terminal, navigate to the project root, and then./run.sh to startthe jekyll process.
2. open atom, then open that root directory (clover-O on OSX).
3. [one time]: install package that will do html previews (i.e., watch the htmlfile and reload it if it changes, also render it as it appears in a web browser).@pearsonca uses "Atom Html Preview" package.
4. open_site/index.html in atom, then activate preview of that page. You mayclose the editing tab for index.html
5. restrictions: html preview may not support all browser capabilities (e.g., noback button)

As you develop, jekyll will update the rendered files, and the preview pluginwill reload them. @pearsonca : I expect that there will soon be a plugin that also addressesthe jekyll startup + provides the terminal output (e.g., when regens occur) in-editor.