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