From 0e8f1e6e98a7e7a621d90cd13b52883546e78538 Mon Sep 17 00:00:00 2001 From: Landon Curt Noll Date: Sun, 28 Jul 2024 21:31:01 -0700 Subject: [PATCH] align no thank you's in markdown.html, add make markdown Added `make markdown` to the top level `Makefile` to just build the `markdown.html` file. Sorted make rules that build individual HTML files. Performed `make gen_top_html` to accomplish the above and to test under macOS. --- Makefile | 31 ++++++++++++++++--------------- markdown.html | 16 ++++++++-------- markdown.md | 17 ++++++++--------- 3 files changed, 32 insertions(+), 32 deletions(-) diff --git a/Makefile b/Makefile index 848a5b18f..7d5f6ca48 100644 --- a/Makefile +++ b/Makefile @@ -352,12 +352,13 @@ help: @echo @echo '# Rules for building specific web pages, a subset of rules mentioned above:' @echo - @echo 'make thanks ;: generate thanks-for-help.html' @echo 'make bugs ;: generate bugs.html' - @echo 'make rules ;: generate next/rules.hmtl' + @echo 'make faq ;: generate faq.html' @echo 'make guidelines ;: generate next/guidelines.hmtl' - @echo 'make faq ;: generate faq.html' + @echo 'make markdown ;: generate markdown.hmtl' + @echo 'make rules ;: generate next/rules.hmtl' @echo 'make security ;: generate SECURITY.html' + @echo 'make thanks ;: generate thanks-for-help.html' @echo @echo '# Compound make rules for building a local copy of the IOCCC website:' @echo @@ -588,6 +589,13 @@ bugs: ${GEN_TOP_HTML} bugs.md @echo "Eh, what's up, doc?" @echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-=' +faq: ${GEN_TOP_HTML} faq.md + @echo '=-=-=-=-= IOCCC begin make $@ =-=-=-=-=' + @echo "You have a question?" + ${GEN_TOP_HTML} -v 1 faq + @echo "Perhaps the FAQ might help!" + @echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-=' + gen_next: ${GEN_TOP_HTML} next/README.md next/guidelines.md next/rules.md @echo '=-=-=-=-= IOCCC begin make $@ =-=-=-=-=' ${GEN_TOP_HTML} -v 1 next/README @@ -595,23 +603,16 @@ gen_next: ${GEN_TOP_HTML} next/README.md next/guidelines.md next/rules.md ${GEN_TOP_HTML} -v 1 next/rules @echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-=' +markdown: ${GEN_TOP_HTML} markdown.md + @echo '=-=-=-=-= IOCCC begin make $@ =-=-=-=-=' + ${GEN_TOP_HTML} -v 1 markdown + @echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-=' + rules: ${GEN_TOP_HTML} next/rules.md @echo '=-=-=-=-= IOCCC begin make $@ =-=-=-=-=' ${GEN_TOP_HTML} -v 1 next/rules @echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-=' -guidelines: ${GEN_TOP_HTML} next/guidelines.md - @echo '=-=-=-=-= IOCCC begin make $@ =-=-=-=-=' - ${GEN_TOP_HTML} -v 1 next/guidelines - @echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-=' - -faq: ${GEN_TOP_HTML} faq.md - @echo '=-=-=-=-= IOCCC begin make $@ =-=-=-=-=' - @echo "You have a question?" - ${GEN_TOP_HTML} -v 1 faq - @echo "Perhaps the FAQ might help!" - @echo '=-=-=-=-= IOCCC complete make $@ =-=-=-=-=' - security: ${GEN_TOP_HTML} SECURITY.md @echo '=-=-=-=-= IOCCC begin make $@ =-=-=-=-=' ${GEN_TOP_HTML} -v 1 SECURITY diff --git a/markdown.html b/markdown.html index bdbd2fe5c..57cb0ee0f 100644 --- a/markdown.html +++ b/markdown.html @@ -467,7 +467,7 @@ anchors.

Please do NOT use the obsolete <tt> (teletype) HTML element:

-
    <tt>The tt element is obsolete</tt>              <=== no thank you
+
    <tt>The tt element is obsolete</tt>                       <=== no thank you

Instead use either a monospaced <span> or an inline markdown code block:

    <span style="font-family: monospace;">Use of a monospaced font
                                           is one option,
@@ -482,7 +482,7 @@ anchors.

 
Please do NOT start code blocks at the first column.

 
For example:

 
``` <!---sh-->
-echo "This code block is NOT indented"                       <=== no thank you
+echo "This code block is NOT indented"                        <=== no thank you
 ```

 
We request that you indent the code block by multiples of 4 ASCII SPACES:

 
``` <!---sh-->
@@ -513,10 +513,10 @@ used as part of the leading whitespace within a markdown file.

 ASCII tab characters anywhere inside a markdown file:

 
For example:

 
```
-    Please do **NOT**   use ASCII tabs  in markdown files.      <=== no thank you
-        Please do **NOT** indent markdown with ASCII tabs.      <=== no thank you
+    Please do **NOT**   use ASCII tabs  in markdown files.    <=== no thank you
+        Please do **NOT** indent markdown with ASCII tabs.    <=== no thank you
 
-        We      don't   mind    tabs    in      general,        <=== no thank you
+        We      don't   mind    tabs    in      general,      <=== no thank you
      We just ask that you NOT use them in markdown files.
 ```

 
And to clarify, we are only talking about markdown files,
@@ -556,7 +556,7 @@ spaces.

 blocks
 NOT specify a language directly.

 
For example:

-
```c                                                            <=== no thank you
+
```c                                                          <=== no thank you
     int main(void) {return 0;}
 ```

 
Instead, put the language inside an HTML comment, separated from the
@@ -732,12 +732,12 @@ an underscore (_). Using an asterisk can complicate parsing and som
 to incorrect results. This can especially go for when it is bold and
 italic.

 
For example, instead of:

-
     *this text is italic*        <=== no thank you

+
     *this text is italic*                                    <=== no thank you

 
use:

 
     _this text is italic_

 
Another example, for bold italic:

 
Do NOT use:

-
     ***this text is bold italic***         <=== no thank you

+
     ***this text is bold italic***                           <=== no thank you

 
Instead use:

 
     **_this text is bold italic_**

 
or:

diff --git a/markdown.md b/markdown.md
index 562664e01..e1d4d11ca 100644
--- a/markdown.md
+++ b/markdown.md
@@ -145,7 +145,7 @@ Please do **NOT** use the obsolete ``
 (**teletype**) HTML element:
 
 ``` 
-    The tt element is obsolete              <=== no thank you
+    The tt element is obsolete                       <=== no thank you
 ```
 
 Instead use either a monospaced `` or an inline markdown code block:
@@ -175,7 +175,7 @@ For example:
 
 ```` 
 ``` <%%NO_COMMENT%%!---sh-->
-echo "This code block is NOT indented"                       <=== no thank you
+echo "This code block is NOT indented"                        <=== no thank you
 ```
 ````
 
@@ -223,10 +223,10 @@ For example:
 
 ```` 
 ```
-    Please do **NOT**	use ASCII tabs	in markdown files.      <=== no thank you
-	Please do **NOT** indent markdown with ASCII tabs.      <=== no thank you
+    Please do **NOT**	use ASCII tabs	in markdown files.    <=== no thank you
+	Please do **NOT** indent markdown with ASCII tabs.    <=== no thank you
 
-	We	don't	mind	tabs	in	general,        <=== no thank you
+	We	don't	mind	tabs	in	general,      <=== no thank you
      We just ask that you NOT use them in markdown files.
 ```
 ````
@@ -294,7 +294,7 @@ blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks)
 For example:
 
 ```` 
-```c                                                            <=== no thank you
+```c                                                          <=== no thank you
     int main(void) {return 0;}
 ```
 ````
@@ -617,7 +617,7 @@ italic_**.
 For example, instead of:
 
 ``` 
-     *this text is italic*        <=== no thank you
+     *this text is italic*                                    <=== no thank you
 ```
 
 use:
@@ -632,7 +632,7 @@ Do **NOT** use:
 
 
 ``` 
-     ***this text is bold italic***         <=== no thank you
+     ***this text is bold italic***                           <=== no thank you
 ```
 
 Instead use:
@@ -646,4 +646,3 @@ or:
 ``` 
      _**this text is bold italic**_
 ```
-