Custom Information
_config.yml
: Customize set up information for use assite.variables
index.html
: Course description and site navigationabout/
:acknowledgements.md
,audience.md
, andwhy-.
files
Initialization Materials
Self-Guided
START-for-self-guided-students.md
: Anyone should be able to start from here
Course / Workshop
computer-setup.md
: List preparations for prerequisite knowledge & technologysyllabus.md
: Course details and policy.
Layout and Linkages
START-for-self-guided-students.md syllabus.md
\____________________________/
|
schedule.md
|
_______________________|_____________________
/ | \
readings/ lectures/ assignments/
schedule.md
generates links for a list ofassignments:
for each of the major courseelement:
reading
,lecture
,assignments
- These
element:
must share atitle:
that is inserted into theassignments:
list andlanguage:
element:
may share a common file name,language-short-description.md
.assignments/
MUST have alower
case file name.readings/
andlectures/
have anUPPER
first letter of the file name, for proper inclusion inassignments/
.
readings/ lectures/ assignments/
--- --- ---
layout: page layout: page layout: page
element: reading element: lecture element: assignment
title: Hello World title: Hello World title: Hello World
language: Foo language: Foo language: Foo
--- --- exercises: ['Ba Ram', 'Ewe']
---
lectures/ --> materials/
---
layout: page
element: notes
title: Hello Foos
language: Foo
---
lectures/
use links to organizematerials/
.[link text](/nanopore-mod-course/materials/file-name)
- NB: no
.MD
afterfile-name
assignments/
______________|_____________
/ | \
readings/ lectures/ exercises/
_____|_____
/ | \
solutions/ code/ data/
assignments/
organizeexercises/
with theexercise:
list ofexercises/
title:
---
layout: exercise
topic: Practice
title: Ba Ram
language: Foo
---
exercises/
file names share similar values toexercises/
YAML in the form:Topic-title-Language.md
.- From the above YAML:
Practice-ba-ram-Foo.md
- From the above YAML:
exercises/
file names MUST start with anUPPER
first letter.solutions
/ file names MUST match theexercises/
file name and can use any extension. For example:Practice-ba-ram-Foo.txt
- Multiple
solutions/
files can be numbered following theexercises/
file name and before the file extension with a-
.Practice-ba-ram-Foo-1.txt
,Practice-ba-ram-Foo-2.jpg
, …
code/
anddata/
files can be linked to exercises[Code file](/nanopore-mod-course/code/code-file.foo)
[Data file](/nanopore-mod-course/data/data-file.csv)