Skip to content
Snippets Groups Projects
Commit 30ed6544 authored by Greg Wilson's avatar Greg Wilson
Browse files

Configuration template

parent 25fdcb68
Branches
Tags
No related merge requests found
......@@ -37,7 +37,7 @@ You also agree to abide by our
* `CONTRIBUTING.md`: these contribution guidelines.
* `LICENSE.md`: license.
* `Makefile`: all the commands needed for development.
* `_config.yml`: general configuration settings (used on GitHub).
* `_config_template.yml`: template for general configuration settings.
* `_config_dev.yml`: configuration overrides for local development.
* `_episodes`: source files for teaching episodes (discussed below).
* `_includes`: page fragments used in layout.
......@@ -54,6 +54,9 @@ You also agree to abide by our
`_episodes/01-xyz.md` generates `/01-xyz/index.html`,
which can be linked to using `/01-xyz/`.
5. Copy `_config_template.yml` to create `_config.yml`
and then edit the settings in the top half.
## Other Resources
1. This lesson is based on the template found at
......
#------------------------------------------------------------
# Values for this site.
#------------------------------------------------------------
# Domain for searches.
domain: "https://USERNAME.github.io/LESSON-NAME"
# URL for repository.
repo: "https://github.com/USERNAME/LESSON-NAME"
# Root URL for lesson below domain.
root: "/LESSON-NAME"
# Overall lesson title.
title: "Instructor Training"
# Contact email address.
email: USERNAME@SOME.WHERE
#------------------------------------------------------------
# Generic settings (should not need to change).
#------------------------------------------------------------
# Sites.
amy_site: "https://amy.software-carpentry.org/workshops"
dc_site: "https://datacarpentry.org"
swc_github: "https://github.com/swcarpentry"
swc_site: "https://software-carpentry.org"
# Start time in minutes (540 is 09:00 am)
start_time: 540
# Specify that things in the episodes collection should be output.
collections:
episodes:
output: true
permalink: /:path/
# Set the default layout for things in the episodes collection.
defaults:
- scope:
path: ""
type: episodes
values:
layout: episode
# Files and directories that are not to be copied.
exclude:
- Makefile
# Turn off built-in syntax highlighting.
highlighter: false
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment