Skip to contents

Project setup and management

Initialize a grading project and inspect or edit its configuration.

init_project()
Initialize a markermd grading project
project_config()
Read a markermd project's configuration
project_set()
Change a markermd project's configuration
project_sitrep()
Report a markermd project's status
validate_project()
Validate a project's student repositories against its template
markermd_skills_path()
Path to the bundled markermd Claude Code skills

Grading apps

The interactive template editor and marking interface.

mark()
Launch the markermd Marking Application
template()
Launch the markermd Template Creation Application

Templates

Author, inspect, and move grading templates in and out of the project database.

assignment_outline()
Outline the gradable sections of an assignment
template_import()
Import a grading template from YAML into a project's database
template_export()
Export a project's grading template to YAML
add_question()
Add Question to Template
remove_question()
Remove Question from Template
get_question()
Get Question by ID
template_methods
Methods for Markermd Template Classes
parse_assignment_document()
Parse an assignment document into a Pandoc AST

Rubrics

Move per-question rubrics between the project database and YAML.

rubric_import()
Import a grading rubric from YAML into a project's database
rubric_export()
Export a project's grading rubric to YAML

Marks and score export

Import, export, and set recorded grading, and export scores and comments.

marks_import()
Import grading marks from YAML into a project's database
marks_export()
Export a project's grading marks to YAML
marks_set()
Record grading marks for one repository/question pair
export_scores()
Export per-repository scores to a CSV file
export_comments()
Export student-facing feedback to per-repository markdown files
export_marks()
Export scores and feedback for a graded project

YAML file formats

Read, write, and schema-validate the template, rubric, and marks file formats.

read_template_yaml()
Read a markermd template from a YAML file
write_template_yaml()
Write a markermd template to a YAML file
validate_template_file()
Validate a template file against the markermd JSON Schema
read_rubric_yaml()
Read a grading rubric from a YAML file
write_rubric_yaml()
Write a grading rubric to a YAML file
validate_rubric_file()
Validate a rubric file against the markermd JSON Schema
read_marks_yaml()
Read grading marks from a YAML file
write_marks_yaml()
Write grading marks to a YAML file
validate_marks_file()
Validate a marks file against the markermd JSON Schema

Classes and vocabularies

S7 classes for templates, questions, rules, filters, and grading state, plus the allowed rule vocabularies.

markermd_template()
Markermd Template
markermd_question()
Template Question
markermd_node_selection()
Node Selection for Questions
markermd_metadata()
Template Metadata
markermd_rule()
Markermd Validation Rule
markermd_filter_condition()
Markermd Filter Condition
markermd_filter_group()
Markermd Filter Group
markermd_rubric_item()
Rubric Item
markermd_grade_state()
Grade State S7 Class
markermd_project()
Markermd Project
get_allowed_rule_verbs()
Get allowed verbs for rules
get_allowed_node_types()
Get allowed node types for rules
get_allowed_filter_condition_types()
Get allowed filter condition types
template_classes
S7 Class Definitions for Markermd Templates
project_classes
S7 Class Definition for Markermd Projects
rule_classes
S7 Class for Rule Validation
rule_helpers
Helper Functions for Rule Validation
filter_classes
S7 Classes for Question Filters
filter_helpers
Helper Functions for Question Filters