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 # Life cycle stage of the lesson
  16 # possible values: "pre-alpha", "alpha", "beta", "stable"
  17 life_cycle: "pre-alpha"
  18
  19 #------------------------------------------------------------
  20 # Generic settings (should not need to change).
  21 #------------------------------------------------------------
  22
  23 # What kind of thing is this ("workshop" or "lesson")?
  24 kind: "lesson"
  25
  26 # Magic to make URLs resolve both locally and on GitHub.
  27 # See https://help.github.com/articles/repository-metadata-on-github-pages/.
  28 # Please don't change it: <USERNAME>/<PROJECT> is correct.
  29 repository: <USERNAME>/<PROJECT>
  30
  31 # Email address, no mailto:
  32 email: "team@carpentries.org"
  33
  34 # Sites.
  35 amy_site: "https://amy.carpentries.org/workshops"
  36 carpentries_github: "https://github.com/carpentries"
  37 carpentries_pages: "https://carpentries.github.io"
  38 carpentries_site: "https://carpentries.org/"
  39 dc_site: "https://datacarpentry.org"
  40 example_repo: "https://github.com/carpentries/lesson-example"
  41 example_site: "https://carpentries.github.io/lesson-example"
  42 lc_site: "https://librarycarpentry.org/"
  43 swc_github: "https://github.com/swcarpentry"
  44 swc_pages: "https://swcarpentry.github.io"
  45 swc_site: "https://software-carpentry.org"
  46 template_repo: "https://github.com/carpentries/styles"
  47 training_site: "https://carpentries.github.io/instructor-training"
  48 workshop_repo: "https://github.com/carpentries/workshop-template"
  49 workshop_site: "https://carpentries.github.io/workshop-template"
  50 cc_by_human: "https://creativecommons.org/licenses/by/4.0/"
  51
  52 # Surveys.
  53 pre_survey: "https://carpentries.typeform.com/to/wi32rS?slug="
  54 post_survey: "https://carpentries.typeform.com/to/UgVdRQ?slug="
  55 instructor_pre_survey: "https://www.surveymonkey.com/r/instructor_training_pre_survey?workshop_id="
  56 instructor_post_survey: "https://www.surveymonkey.com/r/instructor_training_post_survey?workshop_id="
  57
  58
  59 # Start time in minutes (0 to be clock-independent, 540 to show a start at 09:00 am).
  60 start_time: 0
  61
  62 # Specify that things in the episodes collection should be output.
  63 collections:
  64   episodes:
  65     output: true
  66     permalink: /:path/index.html
  67   extras:
  68     output: true
  69     permalink: /:path/index.html
  70
  71 # Set the default layout for things in the episodes collection.
  72 defaults:
  73   - values:
  74       root: .
  75       layout: page
  76   - scope:
  77       path: ""
  78       type: episodes
  79     values:
  80       root: ..
  81       layout: episode
  82   - scope:
  83       path: ""
  84       type: extras
  85     values:
  86       root: ..
  87       layout: page
  88
  89 # Files and directories that are not to be copied.
  90 exclude:
  91   - Makefile
  92   - bin/
  93   - .Rproj.user/
  94   - .vendor/
  95
  96 # Turn on built-in syntax highlighting.
  97 highlighter: rouge