bhaskar-manguluri / cs109test

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

classtmpl

A template to create class websites using pelican, on github.

pip install pelican==3.4
pip install markdown==2.4

files to edit:

  • pelicanconf.py
  • publishconf.py
  • sitestuff.py

At the top level directory, to bring in modules, etc in support:

export PYTHONPATH=`pwd`

make your edits:

  • do the ipython notebooks and a md file in which a notebook is embedded in Lectures/Homeworks/etc (see Homework folder for an example)
  • a makefile copies both the md file and the ipython notebook from there to the content folder and its subfolders posts and notebooks
  • the main concept is bloggy, so that you can run a class over the semester
  • if you need non bloggy pages look and edit them in content/pages. The index file and other files like syllabus/about/contact/schedule are all there
  • all the navigation is done by MENUITEMS in pelicanconf.py. The look of index page is controlled by stuff in sitestuff.py and index.md in pages.

you may need to edit the makefile for flowing images and other resources.

make homework 
make labs
make lectures
make other

git add .
git commit -m "commit message" -a
git push (you are pushing master)

make html 
make serve (to serve locally) on localhost:8000 

make github (uses gh-import to push to gh-pages branch)

About


Languages

Language:Jupyter Notebook 89.1%Language:CSS 7.8%Language:HTML 1.5%Language:Python 1.0%Language:JavaScript 0.3%Language:Makefile 0.1%Language:Smarty 0.1%Language:Shell 0.1%