tttml

tools for formatting a very basic markdown-like format
Log | Files | Refs | README

commit b507855bac3a7d1ca9576b1f02809fa2e804101e
parent 90cc0673d34514966f93faff6c62c79babc8faf0
Author: Josuah Demangeon <mail@josuah.net>
Date:   Thu, 19 Apr 2018 02:41:09 +0200

usual facilities

Diffstat:
AMakefile | 10++++++++++
Amarkup.5 | 136+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 146 insertions(+), 0 deletions(-)

diff --git a/Makefile b/Makefile @@ -0,0 +1,10 @@ +BIN = markup-fmt markup-gopher +MAN1 = markup-fmt.1 markup-gopher.1 +MAN5 = markup.5 + +all: + +install: + mkdir -p $(PREFIX)/bin $(PREFIX)/man/man1 $(PREFIX)/man/man5 + cp $(MAN1) $(PREFIX)/share/man/man1 + cp $(MAN5) $(PREFIX)/share/man/man5 diff --git a/markup.5 b/markup.5 @@ -0,0 +1,136 @@ +.Dd $Mdocdate: April 19 2018$ +.Dt MARKUP 5 +.Os +. +. +.Sh NAME +. +.Nm markup +.Nd simpler markup syntax than markdown +. +. +.Sh SYNOPSIS +. +.Pa markup.md +. +. +.Sh DESCRIPTION +. +The +.Nm +format is a very simple format for writiing text that look good +enough to be published without conversion. +It lacks the markdown recursive syntax +.Pq such as recursive lists anb quotes +which also remove markdown ambiguities. +. +Each block of text is separated from anotherone by an empty line. +. +.Bl -tag -width 6n +. +.It paragraph +Any non-special block of text: +. +.Bd -literal -offset 3n +First paragraph of text. + +Second paragraph of text. +.Ed +. +.It title +Block that ends by a line with only +.Sq Li = : +. +.Bd -literal -offset 3n +Title can therefore have multiple lines if required +although it is not advised. +====================================================== +.Ed +. +.It heading +Block that ends with a line with only +.Sq Li - : +. +.Bd -literal -offset 3n +Heading can also have multiple lines +------------------------------------------------------ +.Ed +. +.It subheading +Block with a single line with at least 3 leading +.Sq Li # +characters starting at subheading and going down the outline +.Pq subheading, subsubheading ... +every time an additionnal +.Sq Li # +is added: +. +.Bd -literal -offset 3n +### Subheading + +#### Subsubheading + +##### Subsubsubheading +.Ed +. +.It tag +Block that start with a tag line: +. +.Bd -literal -offset 3n +*tagline with asterisks and a column*: +Body of the tag block that can span over multiple +lines like regular paragraphs. +.Ed +. +.It list +Block that start with a dash: +.Bd -literal -offset 3n +- List item. The following lines might not have + leading space. + +- Note that multi-paragraph lists are not handled +.Ed +. +.It quote +Block that has a leading +.Sq Li > +on every line: +. +.Bd -literal -offset 3n +> Mail-style quoting. Note that nested quotes +> are not handled. +.Ed +. +.It literal +Block that has a leading tab on every line: +. +.Bd -literal -offset 3n + Nothing gets interpreted in these blocks. + They get printed as-is. + They may contain extra tabs. +.Ed +. +.It link +Block that start with a label line and eventual subsequent description +lines: +. +.Bd -literal -offset 3n +[label]: git://josuah.net/git/markup.git +git repository for the markup set of tools + +[label2]: /url/without/description.txt +.Ed +. +.El +. +. +.Sh SEE ALSO +.Xr smu 1 , +.Lk https://github.com/Gottox/smu "simple markup - markdown like syntax" +. +. +.Sh AUTHORS +. +.An Josuah Demangeon +. +.Aq Mt mail@josuah.net