From f9535fc7d640f6a908a22032087976e654911da3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?John=20Ankarstr=C3=B6m?= Date: Sat, 30 Jan 2021 12:21:56 +0000 Subject: Update README --- README | 13 +++++++++---- README.html | 14 ++++++++++---- mkfile | 2 +- 3 files changed, 20 insertions(+), 9 deletions(-) diff --git a/README b/README index 110e084..542ab4f 100644 --- a/README +++ b/README @@ -25,6 +25,11 @@ but the work has not been done yet. == Syntax == +Em's complete and exact syntax is defined by its implementation [c], +but this section contains a general description. + + [c] ../tree/aux/emparse + === Block-level formatting === _A single empty line_ always marks a block break. There is @@ -112,14 +117,14 @@ Paragraphs start with no space: _Italic, bold and teletype text_ is marked with the asterisk, the underscore and the backtick, respectively: - Example of *italic* text. + Example of *italic text*. The marks are only valid in certain positions: 1. At word borders - 2. After an opening parenthesis - 3. Before any of `.,:;?!)` - 4. Before a closing parenthesis any of `.,:;?!` + 2. At the beginning of a word after an opening parenthesis + 3. At the end of a word before any of `.,:;?!)` + 4. At the end of a word before a closing parenthesis followed by any of `.,:;?!` _Inline references_ are created with square brackets: diff --git a/README.html b/README.html index 4b5b3c0..9395bf4 100644 --- a/README.html +++ b/README.html @@ -29,6 +29,12 @@ The rc script can (more or less) trivially be translated to POSIX shell, but the work has not been done yet.

Syntax

+

+Em's complete and exact syntax is defined by its implementation (link), +but this section contains a general description. +

+
    +

Block-level formatting

A single empty line always marks a block break. There is @@ -135,16 +141,16 @@ This is another paragraph. the underscore and the backtick, respectively:

-Example of *italic* text.
+Example of *italic text*.
 

The marks are only valid in certain positions:

  1. At word borders -
  2. After an opening parenthesis -
  3. Before any of .,:;?!) -
  4. Before a closing parenthesis any of .,:;?! +
  5. At the beginning of a word after an opening parenthesis +
  6. At the end of a word before any of .,:;?!) +
  7. At the end of a word before a closing parenthesis followed by any of .,:;?!

diff --git a/mkfile b/mkfile index 74bd7b8..63a45ce 100644 --- a/mkfile +++ b/mkfile @@ -1,4 +1,4 @@ -test: +test.html: em test.em > test.html README.html: README -- cgit v1.2.3