true, the detailed function descriptions are listed by
-name, otherwise they are listed in the order of occurrence in
+name; otherwise, they are listed in the order of occurrence in
the source file. The default value is true.
@docfile "doc/README.edoc"-
By running sed, then edoc, this makes the README.edoc part of the overview page. You could also make the README.md straight into an overview.edoc but the way it is allows allows to embed it into additional context information that should be useful for a proper html doc.
+By running sed, then edoc, this makes the README.edoc part of the overview page. You could also make the README.md straight into an overview.edoc but the way it is allows to embed it into additional context information that should be useful for a proper html doc.
Accordingly, the sample stub overview.edoc used for the samples here, looks like this:
From 9ccfef7318540b695c7711cac631b560ea2c449b Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 12 Oct 2025 10:12:31 -0600 Subject: [PATCH 06/10] spelling: case-sensitive Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- bin/MARKEDOC-README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bin/MARKEDOC-README.md b/bin/MARKEDOC-README.md index 1de1fed..636e060 100644 --- a/bin/MARKEDOC-README.md +++ b/bin/MARKEDOC-README.md @@ -102,7 +102,7 @@ both worlds: This makes a tag `[example][]' into a direct jump to the headline 'Example', in both markdown and edoc. -Markdown actually uses the `[sample]: #sample' reference. EDoc, however, automatically inserts an anchor for 'Example' being a headline, and of the same name. (The links are not case sensitive.) +Markdown actually uses the `[sample]: #sample' reference. EDoc, however, automatically inserts an anchor for 'Example' being a headline, and of the same name. (The links are not case-sensitive.) If you get the reference wrong or forget to make it, the link tag will be displayed in the open, as actual `[example][]'. From 90cd24ad019aab74d44d03ed0e389021af092746 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 12 Oct 2025 10:47:24 -0600 Subject: [PATCH 07/10] =?UTF-8?q?spelling:=20gro=C3=9F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- bin/markedoc.sed | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bin/markedoc.sed b/bin/markedoc.sed index 8f07353..1dd0a46 100644 --- a/bin/markedoc.sed +++ b/bin/markedoc.sed @@ -46,7 +46,7 @@ # ********************************************************** # SCRIPT # ********************************************************** -# Ach, da kommt der Meister! Herr, die Not ist groß! ~~~ +# Ach, da kommt der Meister! Herr, die Not ist groß! ~~~ # ~~~ Die ich rief, die Geister, Werd ich nun nicht los. # ---------------------------------------------------------- # This is a sed script for use with -E/-r regexes & NOT -n. From 2a99627610cdabaed4adc266622a094a88b97e52 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 12 Oct 2025 10:15:37 -0600 Subject: [PATCH 08/10] spelling: macos Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- README.md | 2 +- bin/MARKEDOC-README.md | 20 +++++++++---------- bin/markedoc.sed | 8 ++++---- doc/README.md | 2 +- doc/overview.edoc | 2 +- samples/markedoc/SAMPLE3.md | 18 ++++++++--------- samples/markedoc/test-bsd.sh | 2 +- samples/markedoc/test-macosx.sh | 2 +- .../markedoc/what-you-should-see/SAMPLE3.edoc | 18 ++++++++--------- .../markedoc/what-you-should-see/sample3.html | 18 ++++++++--------- 10 files changed, 46 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index b093dd3..b403aa3 100644 --- a/README.md +++ b/README.md @@ -162,7 +162,7 @@ your `README.md` to an `EDoc` file. See [bin/MARKEDOC-README.md](http://github.com/uwiger/edown/blob/master/bin/MARKEDOC-README.md). -**FreeBSD, Mac OS X**`$ sed -E -f markedoc.sed