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