Overview

The {sandpaper} package was created by The Carpentries to simplify the process of creating lesson websites for their workshops. It allows users to generate a static website with customized layouts and styling similar to The Carpentries lessons. The package is designed to separate the tools needed to build the site from the user-defined content, making it easier for lesson contributors and maintainers. The website generated by {sandpaper} includes features such as optional offline use, flexible episode arrangements, versioning, seamless style updates, caching of rendered content, and validation of lesson structure.

Features

Optional offline use: The generated website can be accessed offline.
Flexible episode arrangements: The package supports filename-agnostic episode arrangements.
Versioning: The website can be versioned, allowing users to navigate to different releases.
Seamless style updates: The Carpentries' style can be updated without affecting the lesson content.
Caching of rendered content: Rendered content is cached for rapid deployment.
Validation of lesson structure: The package validates the structure of the lesson.
Git-aware: The package is aware of Git but doesn't require contributors to have it installed.

Summary

The {sandpaper} package by The Carpentries simplifies the process of creating lesson websites by generating a static website with customized layouts and styling. It separates the tools required to build the site from the user-defined content, making it easier for contributors and maintainers. The package offers several features, including offline use, flexible episode arrangements, versioning, seamless style updates, caching of rendered content, validation of lesson structure, and Git awareness. Installation of the package can be done from The Carpentries Universe, and it also installs additional development packages.

Carpentries

Amy

Sandpaper