Fix links/formatting in markdown.md

Something that was not noted in the other commit that touched this file
is that because this is markdown which renders to html I changed the
comments in the form of:

	<=== no thank you

to

	<!-- no thank you -->

This was not strictly necessary but and for non html it might not even
make sense except that it is still rendered to html and in most cases
(if not all) it is html. This was done for the rest of the file now too.
This commit is contained in:
Cody Boone Ferguson committed 2024-06-15 11:33:12 -07:00
1 parent a98d8397a4
commit fb59e1203f
2 files changed
+22 -22

No files matched your search

+11 -11
View File
@@ -462,17 +462,17 @@ tags</a>.</p>
<p>The trailing slash on void HTML elements has no effect and interacts badly with <p>The trailing slash on void HTML elements has no effect and interacts badly with
unquoted attribute values.</p> unquoted attribute values.</p>
<p>For example, please do NOT use:</p> <p>For example, please do NOT use:</p>
<pre><code> &lt;br/&gt; &lt;=== no thank you</code></pre> <pre><code> &lt;br/&gt; &lt;!-- no thank you --&gt;</code></pre>
<p>Instead use just:</p> <p>Instead use just:</p>
<pre><code> &lt;br&gt;</code></pre> <pre><code> &lt;br&gt;</code></pre>
<p>And for example, please do NOT use:</p> <p>And for example, please do NOT use:</p>
<pre><code> &lt;hr/&gt; &lt;=== no thank you</code></pre> <pre><code> &lt;hr/&gt; &lt;!-- no thank you --&gt;</code></pre>
<p>Instead use just:</p> <p>Instead use just:</p>
<pre><code> &lt;hr&gt;</code></pre> <pre><code> &lt;hr&gt;</code></pre>
<p>And for example, please do NOT use:</p> <p>And for example, please do NOT use:</p>
<pre><code> &lt;img src=&quot;1984-anonymous-tattoo.jpg&quot; <pre><code> &lt;img src=&quot;1984-anonymous-tattoo.jpg&quot;
alt=&quot;image of a tattoo of the 1984 anonymous C code&quot; alt=&quot;image of a tattoo of the 1984 anonymous C code&quot;
width=600 height=401 /&gt; &lt;=== no thank you</code></pre> width=600 height=401 /&gt; &lt;!-- no thank you --&gt;</code></pre>
<p>Instead use just:</p> <p>Instead use just:</p>
<pre><code> &lt;img src=&quot;1984-anonymous-tattoo.jpg&quot; <pre><code> &lt;img src=&quot;1984-anonymous-tattoo.jpg&quot;
alt=&quot;image of a tattoo of the 1984 anonymous C code&quot; alt=&quot;image of a tattoo of the 1984 anonymous C code&quot;
@@ -483,7 +483,7 @@ unquoted attribute values.</p>
end a markdown line with a trailing backslash (<code>\</code>). Instead use end a markdown line with a trailing backslash (<code>\</code>). Instead use
a trailing <code>&lt;br&gt;</code>.</p> a trailing <code>&lt;br&gt;</code>.</p>
<p>Instead of:</p> <p>Instead of:</p>
<pre><code> In markdown,\ &lt;=== no thank you <pre><code> In markdown,\ &lt;!-- no thank you --&gt;
do NOT use trailing\ do NOT use trailing\
backslashes outside of\ backslashes outside of\
a code block</code></pre> a code block</code></pre>
@@ -504,14 +504,14 @@ a trailing <code>&lt;br&gt;</code>.</p>
<h2 id="please-do-not-use-markdown-style-images">Please do NOT use markdown style images</h2> <h2 id="please-do-not-use-markdown-style-images">Please do NOT use markdown style images</h2>
<p>Please do <strong>NOT</strong> use the markdown embedded image element.</p> <p>Please do <strong>NOT</strong> use the markdown embedded image element.</p>
<p>Instead of using this markdown element to embed an image:</p> <p>Instead of using this markdown element to embed an image:</p>
<pre><code> ![alt text](filename.png &quot;Title&quot;) &lt;=== no thank you</code></pre> <pre><code> ![alt text](filename.png &quot;Title&quot;) &lt;!-- no thank you --&gt;</code></pre>
<p>Use an <code>&lt;img ..&gt;</code> HTML element with <code>alt=</code>, <code>width=</code> and <code>length=</code> <p>Use an <code>&lt;img ..&gt;</code> HTML element with <code>alt=</code>, <code>width=</code> and <code>length=</code>
attributes:</p> attributes:</p>
<pre><code> &lt;img src=&quot;filename.png&quot; <pre><code> &lt;img src=&quot;filename.png&quot;
alt=&quot;describe the filename.png image for someone who cannot view it&quot; alt=&quot;describe the filename.png image for someone who cannot view it&quot;
width=PIXEL_WIDTH height=PIXEL_HEIGHT&gt;</code></pre> width=PIXEL_WIDTH height=PIXEL_HEIGHT&gt;</code></pre>
<p>For example, instead of:</p> <p>For example, instead of:</p>
<pre><code> ![1984-anonymous-tattoo.jpg](1984-anonymous-tattoo.jpg) &lt;=== no thank you</code></pre> <pre><code> ![1984-anonymous-tattoo.jpg](1984-anonymous-tattoo.jpg) &lt;!-- no thank you --&gt;</code></pre>
<p>use this HTML:</p> <p>use this HTML:</p>
<pre><code> &lt;img src=&quot;1984-anonymous-tattoo.jpg&quot; <pre><code> &lt;img src=&quot;1984-anonymous-tattoo.jpg&quot;
alt=&quot;image of a tattoo of the 1984 anonymous C code&quot; alt=&quot;image of a tattoo of the 1984 anonymous C code&quot;
@@ -537,11 +537,11 @@ standard HTML 5 and interacts badly with unquoted attribute values.</p>
<p>Markdown links that end in “))” complicate parsing and sometimes lead <p>Markdown links that end in “))” complicate parsing and sometimes lead
to incorrect URLs or file paths.</p> to incorrect URLs or file paths.</p>
<p>Instead of:</p> <p>Instead of:</p>
<pre><code> [some text](https://example.com/foo_(bar)) &lt;=== no thank you</code></pre> <pre><code> [some text](https://example.com/foo_(bar)) &lt;!-- no thank you --&gt;</code></pre>
<p>Use:</p> <p>Use:</p>
<pre><code> [some text](https://example.com/foo_&amp;#x28;bar&amp;#x29;)</code></pre> <pre><code> [some text](https://example.com/foo_&amp;#x28;bar&amp;#x29;)</code></pre>
<p>Instead of:</p> <p>Instead of:</p>
<pre><code> This thing, ([some text](some/path)), is NOT ideal. &lt;=== no thank you</code></pre> <pre><code> This thing, ([some text](some/path)), is NOT ideal. &lt;!-- no thank you --&gt;</code></pre>
<p>Use:</p> <p>Use:</p>
<pre><code> This thing, [some text](some/path), is better.</code></pre> <pre><code> This thing, [some text](some/path), is better.</code></pre>
<h2 id="please-do-not-place-text-on-the-next-line-after-a-markdown-code-block">Please do NOT place text on the next line after a markdown code block</h2> <h2 id="please-do-not-place-text-on-the-next-line-after-a-markdown-code-block">Please do NOT place text on the next line after a markdown code block</h2>
@@ -557,7 +557,7 @@ NOT properly indented.</p>
return foo; return foo;
} }
``` ```
C compilers cannot be given a -Wno-main-arg-errors flag. &lt;=== no thank you</code></pre> C compilers cannot be given a -Wno-main-arg-errors flag. &lt;!-- no thank you --&gt;</code></pre>
<p>Use:</p> <p>Use:</p>
<pre><code>``` <pre><code>```
int int
@@ -572,11 +572,11 @@ C compilers cannot be given a -Wno-main-arg-errors flag.</code></pre>
<h2 id="please-do-not-put-s-nor-s-in-markdown-link-titles">Please do NOT put “(”s nor “)”s in markdown link titles</h2> <h2 id="please-do-not-put-s-nor-s-in-markdown-link-titles">Please do NOT put “(”s nor “)”s in markdown link titles</h2>
<p>Please do <strong>NOT</strong> use parenthesis inside the markdown link titles.</p> <p>Please do <strong>NOT</strong> use parenthesis inside the markdown link titles.</p>
<p>Instead of:</p> <p>Instead of:</p>
<pre><code> [some (text)](https://example.com/cyrds) &lt;=== no thank you</code></pre> <pre><code> [some (text)](https://example.com/cyrds) &lt;!-- no thank you --&gt;</code></pre>
<p>Use:</p> <p>Use:</p>
<pre><code> [some &amp;#x28;text&amp;#x29;](https://example.com/cyrds)</code></pre> <pre><code> [some &amp;#x28;text&amp;#x29;](https://example.com/cyrds)</code></pre>
<p>Instead of:</p> <p>Instead of:</p>
<pre><code> [ls(1)](https://example.com/ls-man-page.1) &lt;=== no thank you</code></pre> <pre><code> [ls(1)](https://example.com/ls-man-page.1) &lt;-- no thank you --&gt;</code></pre>
<p>Use:</p> <p>Use:</p>
<pre><code> [ls&amp;#x28;1&amp;#x29;](https://example.com/ls-man-page.1)</code></pre> <pre><code> [ls&amp;#x28;1&amp;#x29;](https://example.com/ls-man-page.1)</code></pre>
<!-- AFTER: last line of markdown file: markdown.md --> <!-- AFTER: last line of markdown file: markdown.md -->
+11 -11
View File
@@ -165,7 +165,7 @@ unquoted attribute values.
For example, please do NOT use: For example, please do NOT use:
``` ```
<br/> <=== no thank you <br/> <!-- no thank you -->
``` ```
Instead use just: Instead use just:
@@ -177,7 +177,7 @@ Instead use just:
And for example, please do NOT use: And for example, please do NOT use:
``` ```
<hr/> <=== no thank you <hr/> <!-- no thank you -->
``` ```
Instead use just: Instead use just:
@@ -191,7 +191,7 @@ And for example, please do NOT use:
``` ```
<img src="1984-anonymous-tattoo.jpg" <img src="1984-anonymous-tattoo.jpg"
alt="image of a tattoo of the 1984 anonymous C code" alt="image of a tattoo of the 1984 anonymous C code"
width=600 height=401 /> <=== no thank you width=600 height=401 /> <!-- no thank you -->
``` ```
Instead use just: Instead use just:
@@ -214,7 +214,7 @@ a trailing `<br>`.
Instead of: Instead of:
``` ```
In markdown,\ <=== no thank you In markdown,\ <!-- no thank you -->
do NOT use trailing\ do NOT use trailing\
backslashes outside of\ backslashes outside of\
a code block a code block
@@ -251,7 +251,7 @@ Please do **NOT** use the markdown embedded image element.
Instead of using this markdown element to embed an image: Instead of using this markdown element to embed an image:
``` ```
![alt text](filename.png "Title") <=== no thank you ![alt text](filename.png "Title") <!-- no thank you -->
``` ```
Use an `<img ..>` HTML element with `alt=`, `width=` and `length=` Use an `<img ..>` HTML element with `alt=`, `width=` and `length=`
@@ -266,7 +266,7 @@ attributes:
For example, instead of: For example, instead of:
``` ```
![1984-anonymous-tattoo.jpg](1984-anonymous-tattoo.jpg) <=== no thank you ![1984-anonymous-tattoo.jpg](1984-anonymous-tattoo.jpg) <!-- no thank you -->
``` ```
use this HTML: use this HTML:
@@ -318,7 +318,7 @@ to incorrect URLs or file paths.
Instead of: Instead of:
``` ```
[some text](https://example.com/foo_(bar)) <=== no thank you [some text](https://example.com/foo_(bar)) <!-- no thank you -->
``` ```
Use: Use:
@@ -330,7 +330,7 @@ Use:
Instead of: Instead of:
``` ```
This thing, ([some text](some/path)), is NOT ideal. <=== no thank you This thing, ([some text](some/path)), is NOT ideal. <!-- no thank you -->
``` ```
Use: Use:
@@ -357,7 +357,7 @@ Instead of:
return foo; return foo;
} }
``` ```
C compilers cannot be given a -Wno-main-arg-errors flag. <=== no thank you C compilers cannot be given a -Wno-main-arg-errors flag. <!-- no thank you -->
```` ````
Use: Use:
@@ -384,7 +384,7 @@ Please do **NOT** use parenthesis inside the markdown link titles.
Instead of: Instead of:
``` ```
[some (text)](https://example.com/cyrds) <=== no thank you [some (text)](https://example.com/cyrds) <!-- no thank you -->
``` ```
Use: Use:
@@ -396,7 +396,7 @@ Use:
Instead of: Instead of:
``` ```
[ls(1)](https://example.com/ls-man-page.1) <=== no thank you [ls(1)](https://example.com/ls-man-page.1) <-- no thank you -->
``` ```
Use: Use: