Categorygithub.com/traindown/traindown-go
modulepackage
2.0.0+incompatible
Repository: https://github.com/traindown/traindown-go.git
Documentation: pkg.go.dev
Overview
Versions
4
Dependencies
8
Dependents
2
Files
602 SLOC

# README

traindown-go

A language to help athletes express their training. Inspired by Markdown.

# Functions

NewFormatter returns a pointer to a Formatter.
NewLexer returns a new Lexer.
NewMovement spits out a new Movement.
NewPerformance spits out a new Performance.
NewSession spits out a new Session.
ParseByte takes in a Traindown byte slice and returns a pointer to a Session.
ParseString takes in a Traindown string and returns a pointer to a Session.

# Variables

TokenMap maps is an enum.
Tokens used in parsing Traindown inputs.

# Structs

Formatter formats Traindown documents.
Lexer type.
Movement is an thing you do, you know?.
Performance is an expression of a movement.
Session is a collection of Movements that occurred.
Token holds information about a token.

# Type aliases

Metadata is key value pairs.