From a33cf5f40f9250a10ae3ad787bc768bf86c29f16 Mon Sep 17 00:00:00 2001 From: Landon Curt Noll Date: Mon, 29 Apr 2024 11:50:32 -0700 Subject: [PATCH] minor syntax update to markdown.md --- markdown.html | 13 ++++++------- markdown.md | 14 ++++++-------- 2 files changed, 12 insertions(+), 15 deletions(-) diff --git a/markdown.html b/markdown.html index 5c170dc58..b7c9296aa 100644 --- a/markdown.html +++ b/markdown.html @@ -394,7 +394,7 @@ into the markdown file.

In particular there are things we ask people to please do NOT use markdown files:

Do not use name attributes in HTML a tags

Please do not use the HTML construct:

-
    <a name="string">\</a>
+
    <a name="string">\</a>              <=== no thank you

as those are NOT part of the HTML 5 standard.

Instead use:

    <div id="string">...\</div>
@@ -416,7 +416,7 @@ name=”string”></a>”, they may not in the future.

end a markdown line with a trailing backslash (“\”). Instead use a trailing “<br>”.

Instead of:

-
    In markdown,\
+
    In markdown,\                       <=== no thank you
     do not use trailing\
     backslashes outside of\
     a code block

@@ -432,19 +432,18 @@ a trailing “<br>”.

     markdown code\
     block
 ```
-

This will avoid pandoc(1) generating deprecated HTML elements such as:

-

“<br />”

+

This will avoid pandoc(1) generating deprecated HTML elements such as \<br />.

Do not use markdown image elements

Please do not use the markdown embedded image element.

Instead of using this markdown element to embed an image:

-
    ![alt text](filename.png "Title")
+
    ![alt text](filename.png "Title")           <=== no thank you

Use a “img” HTML element with “alt”, “alt”, “width” and “length” attributes:

    <img src="filename.png"
      alt="describe the filename.png image for someone who cannot view it"
      width=PIXEL_WIDTH height=PIXEL_HEIGHT>

For example, instead of:

-
    ![1984-anonymous-tattoo.jpg](1984-anonymous-tattoo.jpg)
+
    ![1984-anonymous-tattoo.jpg](1984-anonymous-tattoo.jpg)     <=== no thank you

use this HTML:

    <img src="1984-anonymous-tattoo.jpg"
      alt="image of a tattoo of the 1984 anonymous C code"
@@ -468,7 +467,7 @@ unquoted attribute values.

 
    <hr style="width:10%;text-align:left;margin-left:0">

 
Do not use the strike HTML element

 
Please not use the HTML element:

-
    <strike>...</strike>

+
    <strike>...</strike>        <=== no thank you

 
Use instead:

 
    <del>...</del>

 
Do not use tt HTML elements

diff --git a/markdown.md b/markdown.md
index adb39ba5c..fd3e05341 100644
--- a/markdown.md
+++ b/markdown.md
@@ -23,7 +23,7 @@ In particular there are things we ask people to please do **NOT** use markdown f
 Please do not use the HTML construct:
 
 ```
-    \
+    \		<=== no thank you
 ```
 
 as those are **NOT** part of the HTML 5 standard.
@@ -67,7 +67,7 @@ a trailing "**\
**".
 Instead of:
 
 ```
-    In markdown,\
+    In markdown,\			<=== no thank you
     do not use trailing\
     backslashes outside of\
     a code block
@@ -93,9 +93,7 @@ Again, use of a trailing backslash ("\\") inside a markdown code block is fine:
 ```
 ````
 
-This will avoid `pandoc(1)` generating deprecated HTML elements such as:
-
-"**\
**"
+This will avoid `pandoc(1)` generating deprecated HTML elements such as `\
`.
 
 
 ## Do not use markdown image elements
@@ -105,7 +103,7 @@ Please do not use the markdown embedded image element.
 Instead of using this markdown element to embed an image:
 
 ```
-    ![alt text](filename.png "Title")
+    ![alt text](filename.png "Title")		<=== no thank you
 ```
 
 Use a "img" HTML element with "alt", "alt", "width" and "length"
@@ -120,7 +118,7 @@ attributes:
 For example, instead of:
 
 ```
-    ![1984-anonymous-tattoo.jpg](1984-anonymous-tattoo.jpg)
+    ![1984-anonymous-tattoo.jpg](1984-anonymous-tattoo.jpg)	<=== no thank you
 ```
 
 use this HTML:
@@ -168,7 +166,7 @@ If a short line is needed, use:
 Please not use the HTML element:
 
 ```
-    ...
+    ...	<=== no thank you
 ```
 
 Use instead: