Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1.88 KB

README.md

File metadata and controls

31 lines (20 loc) · 1.88 KB
Raw

gh-syllabus

A template for a Github Pages hosted syllabus.

  • See the live site generated from this repo.
  • See the code in the master branch.
  • Fork/clone this repository and make your own course syllabus on Github Pages.

Syllabi based on this template

Five step setup

  1. Fork this repository.
  2. Enable GitHub Pages to publish your site from master branch.
  3. It should work by now. Check link to the live website right the in the settings.
  4. Edit config.yml and *.md files in _syllabus and this folder to add any content you want.
  5. Replace contents of this README file with description of your syllabus.

Tips

  • The syntax is mostly in easily readable Markdown.
  • Config file is YAML, but may easily see it as name: value list (it works most of the time like this).
  • You may use Github's own editor to edit or add any of the files in repository.
  • Template is based on Jekyll static site generator (that is used by Github Pages). So if you want to dig deeper, you can change almost anything (visuals, content structure, etc.).

Licensed under MIT License.