New Lesson Infrastructure Coming May 2023
Our new lesson infrastructure, The Carpentries Workbench is currently undergoing beta testing and will become default for official Carpentries lessons in May 2023.
This new infrastructure is designed to be more accessible and easier to use than the styles infrastructure by separating tools from the content.
If you would like to create a new lesson, we encourage you to use The Workbench.
Resources
- Markdown Lesson Template Generator: https://bit.ly/new-lesson-md/
- R Markdown Lesson Template Generator: https://bit.ly/new-lesson-rmd/
- Lesson Maintainer/Author Documentation: https://carpentries.github.io/sandpaper-docs/
- Transition Guide: https://carpentries.github.io/workbench/transition-guide.html
- General Information: https://carpentries.github.io/workbench/
- Discussion: https://github.com/carpentries/workbench/discussions
- Bug Reports: https://github.com/carpentries/workbench/issues
- Contact: zkamvar at carpentries dot org
For guidelines on how to develop curriculum content, please visit The Carpentries Curriculum Development Handbook.
This lesson shows how to use The Carpentries lesson template. The materials below assume familiarity with tools such as GitHub, Markdown, and Jekyll. For more guidance, please visit the Technological introductions section of The Carpentries Curriculum Development Handbook.
For guidelines on how to help improve our lessons and this template, please see the contribution guidelines; for guidelines on how to set up your machine to preview changes locally, please see the setup instructions.
Prerequisites
Use the
.prereq
style to specify prerequisites.
Ten Things You Need To Know
- Don’t panic.
- Create a new lesson by using GitHub Import, not by forking.
- Run
bin/lesson_initialize.py
once in a new lesson repository to set up standard files.- Run
make lesson-check
to check that the lesson is formatted correctly.- Put lesson episodes in
_episodes
(or_episodes_rmd
if you are writing in RMarkdown).- Run
make serve
to preview the lesson website locally.- Do not commit the generated HTML files in the
_site
directory.- Style blocks and code samples by putting
{: .stylename}
on a newline after the block or code.- Put solutions inside challenges using nested blockquotes.
- File issues and template fixes in the styles repository, and enhancements to this documentation in this one.