bin/boilerplate/_config.yml

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