minor syntax update to markdown.md
This commit is contained in:
1 parent
551384550f
commit
a33cf5f40f
2 files changed
+12
-15
No files matched your search
+6
-7
@@ -394,7 +394,7 @@ into the markdown file.</p>
|
||||
<p>In particular there are things we ask people to please do <strong>NOT</strong> use markdown files:</p>
|
||||
<h2 id="do-not-use-name-attributes-in-html-a-tags">Do not use name attributes in HTML a tags</h2>
|
||||
<p>Please do not use the HTML construct:</p>
|
||||
<pre><code> <a name="string">\</a></code></pre>
|
||||
<pre><code> <a name="string">\</a> <=== no thank you</code></pre>
|
||||
<p>as those are <strong>NOT</strong> part of the HTML 5 standard.</p>
|
||||
<p>Instead use:</p>
|
||||
<pre><code> <div id="string">...\</div></code></pre>
|
||||
@@ -416,7 +416,7 @@ name=”string”></a></strong>”, they may not in the future.</p>
|
||||
end a markdown line with a trailing backslash (“\”). Instead use
|
||||
a trailing “<strong><br></strong>”.</p>
|
||||
<p>Instead of:</p>
|
||||
<pre><code> In markdown,\
|
||||
<pre><code> In markdown,\ <=== no thank you
|
||||
do not use trailing\
|
||||
backslashes outside of\
|
||||
a code block</code></pre>
|
||||
@@ -432,19 +432,18 @@ a trailing “<strong><br></strong>”.</p>
|
||||
markdown code\
|
||||
block
|
||||
```</code></pre>
|
||||
<p>This will avoid <code>pandoc(1)</code> generating deprecated HTML elements such as:</p>
|
||||
<p>“<strong><br /></strong>”</p>
|
||||
<p>This will avoid <code>pandoc(1)</code> generating deprecated HTML elements such as <code>\<br /></code>.</p>
|
||||
<h2 id="do-not-use-markdown-image-elements">Do not use markdown image elements</h2>
|
||||
<p>Please do not use the markdown embedded image element.</p>
|
||||
<p>Instead of using this markdown element to embed an image:</p>
|
||||
<pre><code> </code></pre>
|
||||
<pre><code>  <=== no thank you</code></pre>
|
||||
<p>Use a “img” HTML element with “alt”, “alt”, “width” and “length”
|
||||
attributes:</p>
|
||||
<pre><code> <img src="filename.png"
|
||||
alt="describe the filename.png image for someone who cannot view it"
|
||||
width=PIXEL_WIDTH height=PIXEL_HEIGHT></code></pre>
|
||||
<p>For example, instead of:</p>
|
||||
<pre><code> </code></pre>
|
||||
<pre><code>  <=== no thank you</code></pre>
|
||||
<p>use this HTML:</p>
|
||||
<pre><code> <img src="1984-anonymous-tattoo.jpg"
|
||||
alt="image of a tattoo of the 1984 anonymous C code"
|
||||
@@ -468,7 +467,7 @@ unquoted attribute values.</p>
|
||||
<pre><code> <hr style="width:10%;text-align:left;margin-left:0"></code></pre>
|
||||
<h2 id="do-not-use-the-strike-html-element">Do not use the strike HTML element</h2>
|
||||
<p>Please not use the HTML element:</p>
|
||||
<pre><code> <strike>...</strike></code></pre>
|
||||
<pre><code> <strike>...</strike> <=== no thank you</code></pre>
|
||||
<p>Use instead:</p>
|
||||
<pre><code> <del>...</del></code></pre>
|
||||
<h2 id="do-not-use-tt-html-elements">Do not use tt HTML elements</h2>
|
||||
|
||||
+6
-8
@@ -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:
|
||||
|
||||
```
|
||||
<a name="string">\</a>
|
||||
<a name="string">\</a> <=== no thank you
|
||||
```
|
||||
|
||||
as those are **NOT** part of the HTML 5 standard.
|
||||
@@ -67,7 +67,7 @@ a trailing "**\<br>**".
|
||||
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:
|
||||
|
||||
"**\<br />**"
|
||||
This will avoid `pandoc(1)` generating deprecated HTML elements such as `\<br />`.
|
||||
|
||||
|
||||
## 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:
|
||||
|
||||
```
|
||||

|
||||
 <=== no thank you
|
||||
```
|
||||
|
||||
Use a "img" HTML element with "alt", "alt", "width" and "length"
|
||||
@@ -120,7 +118,7 @@ attributes:
|
||||
For example, instead of:
|
||||
|
||||
```
|
||||

|
||||
 <=== no thank you
|
||||
```
|
||||
|
||||
use this HTML:
|
||||
@@ -168,7 +166,7 @@ If a short line is needed, use:
|
||||
Please not use the HTML element:
|
||||
|
||||
```
|
||||
<strike>...</strike>
|
||||
<strike>...</strike> <=== no thank you
|
||||
```
|
||||
|
||||
Use instead:
|
||||
|
||||
Reference in new issue
Block a user