Author: Josuah Demangeon <email@example.com>
Date: Thu, 19 Apr 2018 03:45:53 +0200
add a README
|M||Makefile|| | ||4||++++|
|A||README|| | ||86||+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++|
2 files changed, 90 insertions(+), 0 deletions(-)
diff --git a/Makefile b/Makefile
@@ -4,6 +4,10 @@ MAN5 = markup.5
+ mandoc -T utf8 $(MAN5) | col -bx >$@
mkdir -p $(PREFIX)/bin
cp $(BIN) $(PREFIX)/bin
diff --git a/README b/README
@@ -0,0 +1,86 @@
+MARKUP(5) File Formats Manual MARKUP(5)
+ markup simpler markup syntax than markdown
+ The markup format is a very simple format for writiing text that look
+ good enough to be published without conversion. It lacks the markdown
+ recursive syntax (such as recursive lists anb quotes) which also remove
+ markdown ambiguities. Each block of text is separated from anotherone by
+ an empty line.
+ Any non-special block of text:
+ First paragraph of text.
+ Second paragraph of text.
+ title Block that ends by a line with only =:
+ Title can therefore have multiple lines if required
+ although it is not advised.
+ Block that ends with a line with only -:
+ Heading can also have multiple lines
+ Block with a single line with at least 3 leading # characters
+ starting at subheading and going down the outline (subheading,
+ subsubheading ...) every time an additionnal # is added:
+ ### Subheading
+ #### Subsubheading
+ ##### Subsubsubheading
+ tag Block that start with a tag line:
+ *tagline with asterisks and a column*:
+ Body of the tag block that can span over multiple
+ lines like regular paragraphs.
+ list Block that start with a dash:
+ - List item. The following lines might not have
+ leading space.
+ - Note that multi-paragraph lists are not handled
+ quote Block that has a leading > on every line:
+ > Mail-style quoting. Note that nested quotes
+ > are not handled.
+ Block that has a leading tab on every line:
+ Nothing gets interpreted in these blocks.
+ They get printed as-is.
+ They may contain extra tabs.
+ link Block that start with a label line and eventual subsequent
+ description lines:
+ [label]: git://josuah.net/git/markup.git
+ git repository for the markup set of tools
+ [label2]: /url/without/description.txt
+ smu(1), simple markup - markdown like syntax:
+ Josuah Demangeon <firstname.lastname@example.org>
+OpenBSD 6.3 April 19, 2018 OpenBSD 6.3