Man pages for zkamvar/sandpaper
Create and Curate Carpentries Lessons
| build_404 | Build the 404 page for a lesson |
| build_agg | Build a page for aggregating common elements |
| build_episode_html | Build a single episode html file |
| build_episode_md | Build an episode to markdown |
| build_handout | Create a code handout of challenges without solutions |
| build_home | Build a home page for a lesson |
| build_html | Build instructor and learner HTML page |
| build_lesson | Build your lesson site |
| build_markdown | Build plain markdown from the RMarkdown episodes |
| build_site | Wrapper for site builder |
| build_status | Identify what files need to be rebuilt and what need to be... |
| check_lesson | deprecated Check the lesson structure for errors |
| check_pandoc | Check the existence of pandoc |
| ci_build | Build and deploy individual site components to a remote... |
| ci_deploy | (INTERNAL) Build and deploy the site with continous... |
| ci_session_info | Report session information to the user |
| copy_template | copy a sandpaper template file to a path with data |
| create_episode | Create an Episode from a template |
| create_lesson | Create a carpentries lesson |
| create_sidebar | Create the sidebar for varnish |
| create_sidebar_item | Create a single item that appears in the sidebar |
| dependency_management | Lesson Runtime Dependency Management |
| dot-lesson_store | Internal Global Lesson Storage Generator |
| dot-list_store | List Storage Generator |
| fill_translation_vars | Apply template items to translated strings |
| fix_sidebar_href | Fix the refs for a vector of sidebar nodes |
| fixtures | Test fixture functions for sandpaper |
| get_config | Get the configuration parameters for the lesson |
| get_content | Get sections from an episode's HTML page |
| get_drafts | Show files in draft form |
| get_dropdown | Helpers to extract contents of dropdown menus on the site |
| get_nav_data | Generate the navigation data for a page |
| get_resource_list | Get the full resource list of markdown files |
| get_syllabus | Create a syllabus for the lesson |
| git_worktree | Setup a git worktree for concurrent manipulation of a... |
| hash_children | Update file checksums to account for child documents |
| known_languages | Show a list of languages known by sandpaper |
| lesson_storage | Internal cache for storing pre-computed lesson objects |
| make_aio_section | Make a section and place it inside the All In One page |
| make_images_section | Make a section of aggregated images |
| make_instructornotes_section | Make a section of aggregated instructor notes |
| move_episode | Move an episode in the schedule |
| package_cache | Give Consent to Use Package Cache |
| parse_file_matches | Subset file matches to the order they appear in the config... |
| provision | Provision an aggregate page in a lesson |
| read_all_html | read all HTML files in a folder |
| render_html | Render html from a markdown file |
| renv_diagnostics | Print a diagnostics report for the package cache |
| renv_lockfile_hash | Get the hash for the previous and current lockfile (as... |
| reserved_db | Filter reserved markdown files from the built db |
| reset_episodes | Clear the schedule in the lesson |
| reset_site | Remove all files associated with the site |
| sandpaper.options | Global Options |
| sandpaper-package | sandpaper: Create and Curate Carpentries Lessons |
| sandpaper_site | Site generator for sandpaper |
| serve | Build your lesson and work on it at the same time |
| set_config | Set individual keys in a configuration file |
| set_dropdown | Set the order of items in a dropdown menu |
| set_globals | Set the necessary common global variables for use in the... |
| strip_prefix | This will strip existing episode prefixes and set the... |
| template | Template files |
| translations | Establish and Manage Translation Strings |
| try_use_renv | Try to use renv |
| update_github_workflows | Update github workflows |
| update_varnish | Update the local version of the carpentries style |
| validate_lesson | Pre-build validation of lesson elements |
| work_with_cache | (Experimental) Work with the package cache |
| yaml_list | Create a valid, opinionated yaml list for insertion into a... |
