# tml - Terminal Markup Language [![Build Status](https://travis-ci.org/liamg/tml.svg "Travis CI status")](https://travis-ci.org/liamg/tml) [![GoDoc](https://godoc.org/github.com/liamg/tml?status.svg)](https://godoc.org/github.com/liamg/tml) A Go module (and standalone binary) to make the output of coloured/formatted text in the terminal easier and more readable. You can use it in your Go programs, and bash etc. too. ![Example screenshot](example.png) ## Usage in Go The output of coloured/formatted text is easy using the following syntax: ```go package main import "github.com/liamg/tml" func main() { tml.Printf("this text is red and the following is %s\n", "not red") } ``` ## Usage in Bash First, install tml: Install Go and run the following command. ``` # For Go 1.16+ # Make sure that `$GOPATH/bin` is in your `$PATH`, because that's where this gets installed go install github.com/liamg/tml/tml@latest # For Go <1.16 go get -u github.com/liamg/tml/tml ``` Then you can simply pipe text containing tags to tml: ```bash #!/bin/bash echo "this text is red and the following is not red" | tml ``` ## Format Each tag is enclosed in angle brackets, much like HTML. You can nest tags as deeply as you like. It's not required to close tags you've opened, though it can make for easier reading. ### Available Tags #### Foreground Colours - `` - `` - `` - `` - `` - `` - `` - `` - `` - `` - `` - `` - `` - `` - `` - `` #### Background Colours - `` - `` - `` - `` - `` - `` - `` - `` - `` - `` - `` - `` - `` - `` - `` - `` #### Attributes - `` - `` - `` - `` - `` - `` - `` - ``