Skip to content

README.md

Latest commit

 

History

History
30 lines (21 loc) · 1018 Bytes

README.md

File metadata and controls

30 lines (21 loc) · 1018 Bytes

Tutorials

Various STEM related tutorials. View them here

Editing

Warning

  • Do not edit anything in the "docs" folder. These are auto-generated by the "generate.py" script.

Pre-requisites

  • Python3
  • Python3-markdown
  • Sass

Folder structure

courses
  \_ course (dir)
    \_ section (dir)
      \_ page (markdown, .md)
  • When generating html, all files and directories are first sorted according to their prefix number, followed by their filename.
  • Files and directories starting with a "d" will be ignored.
  • "template.html" may be placed in the course or section directory, where it will override the default "template.html" in the courses directory.
  • "images", "css", "js", and "download" folders may be placed in the course directory. Their content will be copied to the docs directory.
  • "scss" folder may be placed in the course directory. Its content will be compiled and output placed in the corresponding css directory under "docs".