bin/boilerplate/_config.yml

   1 #------------------------------------------------------------
   2 # Values for this lesson.
   3 #------------------------------------------------------------
   4
   5 # Which carpentry is this ("swc", "dc", or "lc")?
   6 carpentry: "swc"
   7
   8 # Overall title for pages.
   9 title: "Lesson Title"
  10
  11 # Email address, no mailto:
  12 email: "lessons@software-carpentry.org"
  13
  14 #------------------------------------------------------------
  15 # Generic settings (should not need to change).
  16 #------------------------------------------------------------
  17
  18 # What kind of thing is this ("workshop" or "lesson")?
  19 kind: "lesson"
  20
  21 # Magic to make URLs resolve both locally and on GitHub.
  22 # See https://help.github.com/articles/repository-metadata-on-github-pages/.
  23 repository: <USERNAME>/<PROJECT>
  24
  25 # Sites.
  26 amy_site: "https://amy.software-carpentry.org/workshops"
  27 carpentries_github: "https://github.com/carpentries"
  28 carpentries_pages: "https://carpentries.github.io"
  29 carpentries_site: "https://carpentries.org/"
  30 dc_site: "http://datacarpentry.org"
  31 example_repo: "https://github.com/carpentries/lesson-example"
  32 example_site: "https://carpentries.github.io/lesson-example"
  33 lc_site: "https://librarycarpentry.github.io/"
  34 swc_github: "https://github.com/swcarpentry"
  35 swc_pages: "https://swcarpentry.github.io"
  36 swc_site: "https://software-carpentry.org"
  37 template_repo: "https://github.com/carpentries/styles"
  38 training_site: "https://carpentries.github.io/instructor-training"
  39 workshop_repo: "https://github.com/carpentries/workshop-template"
  40 workshop_site: "https://carpentries.github.io/workshop-template"
  41
  42 # Surveys.
  43 pre_survey: "https://www.surveymonkey.com/r/swc_pre_workshop_v1?workshop_id="
  44 post_survey: "https://www.surveymonkey.com/r/swc_post_workshop_v1?workshop_id="
  45 training_post_survey: "https://www.surveymonkey.com/r/post-instructor-training"
  46
  47 # Start time in minutes (0 to be clock-independent, 540 to show a start at 09:00 am).
  48 start_time: 0
  49
  50 # Specify that things in the episodes collection should be output.
  51 collections:
  52   episodes:
  53     output: true
  54     permalink: /:path/index.html
  55   extras:
  56     output: true
  57     permalink: /:path/index.html
  58
  59 # Set the default layout for things in the episodes collection.
  60 defaults:
  61   - values:
  62       root: .
  63       layout: page
  64   - scope:
  65       path: ""
  66       type: episodes
  67     values:
  68       root: ..
  69       layout: episode
  70   - scope:
  71       path: ""
  72       type: extras
  73     values:
  74       root: ..
  75       layout: page
  76
  77 # Files and directories that are not to be copied.
  78 exclude:
  79   - Makefile
  80   - bin/
  81   - .Rproj.user/
  82
  83 # Turn on built-in syntax highlighting.
  84 highlighter: rouge