@woml/woml-core
v1.2.0
Published
Core utilities and parsers for WoML.
Readme
Workout Markup Language (WoML)
Workout Markup Language (WoML) is a simple, human-readable, text-based format designed for clearly defining fitness routines. WoML aims to simplify documenting, sharing, and performing workouts, bridging the gap between manual input and digital interaction.
Key Goals
Human-Friendly Syntax: Easy to write, edit, and read without specialized tools. Plain Text Portability: Share and distribute effortlessly via any text-based medium. Structured Representation: Consistently formatted to enable rendering into interactive interfaces, similar to HTML for web pages.
Example WoML Format
Here's how you might structure a simple workout:
title: Quick Cardio Circuit
description: Short and effective cardio routine suitable for daily use.
activities:
- title: Warm-up
activities:
- title: Jumping Jacks
target: 60s
- title: Arm Circles
target: 60s
- title: Main Workout
activities:
- title: Push-ups
target: 3x12 # sets x reps
- title: Plank Holds
target: 3x60s # sets x duration (per set)
- title: Cool Down
activities:
- title: Stretching
target: 5mTargets (WoML v1.2)
targetgroups activity goals:sets,reps, andduration.- Shorthand accepted in input and canonicalized by tooling:
3x15→{ sets: 3, reps: 15 }(leaf)3x60s→{ sets: 3, duration: 60s }3x/3 sets/3 rounds→{ sets: 3 }(block or leaf;roundsis normalized tosets)10m→{ duration: 10m }15/15 reps→{ reps: 15 }(leaf only)
Note: Mixing reps with duration is not yet defined; prefer 3x<Duration> for per‑set timing or omit reps when specifying duration.
