make quick_ww due to recent commits
This commit is contained in:
1 parent
697cc91319
commit
8ef10b3df6
2 files changed
+156
-150
No files matched your search
+149
-143
@@ -480,26 +480,32 @@ and ✔️ for preferred correct one.</p>
|
|||||||
<h2 id="start-remarks.md-sections-at-level-3">Start <code>remarks.md</code> sections at level 3</h2>
|
<h2 id="start-remarks.md-sections-at-level-3">Start <code>remarks.md</code> sections at level 3</h2>
|
||||||
<p>If (it is not required) you do use sections in your <code>remarks.md</code> file (this does
|
<p>If (it is not required) you do use sections in your <code>remarks.md</code> file (this does
|
||||||
not apply to other markdown files), <strong>PLEASE</strong> start at level three up to level six:</p>
|
not apply to other markdown files), <strong>PLEASE</strong> start at level three up to level six:</p>
|
||||||
<pre class="<!---markdown-->"><code>❌ # Section Reserved
|
<p><span style="color:red">❌</span> Reserved in <code>remarks.md</code> only.</p>
|
||||||
❌ ## Section Reserved
|
<pre class="<!---markdown-->"><code># Section Reserved
|
||||||
✔️ ### Section Level 3
|
## Section Reserved</code></pre>
|
||||||
✔️ #### Section Level 4
|
<p><span style="color:green">✔</span> Available every where.</p>
|
||||||
✔️ ##### Section Level 5
|
<pre><code>### Section Level 3
|
||||||
✔️ ###### Section Level 6</code></pre>
|
#### Section Level 4
|
||||||
|
##### Section Level 5
|
||||||
|
###### Section Level 6</code></pre>
|
||||||
<div id="anchor-name">
|
<div id="anchor-name">
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<h2 id="replace-a-nameanchor_namea-construct.">Replace <code><a name="anchor_name"></a></code> construct.</h2>
|
<h2 id="replace-a-nameanchor_namea-construct.">Replace <code><a name="anchor_name"></a></code> construct.</h2>
|
||||||
<pre class="<!---html-->"><code>❌ <a name="old_way">...</a>
|
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||||
✔️ <div id="new_way">...</div>
|
<pre class="<!---html-->"><code><a name="old_way">Section title</a></code></pre>
|
||||||
✔️
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
✔️ ### Section title</code></pre>
|
<pre class="<!---html-->"><code><div id="new_way"></div>
|
||||||
|
|
||||||
|
### Section title</code></pre>
|
||||||
<div id="links">
|
<div id="links">
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<h2 id="markdown-links-instead-of-a...a">Markdown links instead of <code><a>...</a></code></h2>
|
<h2 id="markdown-links-instead-of-a...a">Markdown links instead of <code><a>...</a></code></h2>
|
||||||
<pre class="<!---html-->"><code>❌ This <a href="#link_target>HTML link text</a> works, but we prefer
|
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||||
✔️ [markdown link text](#link_target)</code></pre>
|
<pre class="<!---html-->"><code>This <a href="#link_target>HTML link text</a> works, but we prefer see below...</code></pre>
|
||||||
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
|
<pre class="<!---html-->"><code>[markdown link text](#link_target)</code></pre>
|
||||||
<div id="del">
|
<div id="del">
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@@ -507,11 +513,12 @@ not apply to other markdown files), <strong>PLEASE</strong> start at level three
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
<h2 id="replace-strike-or-s">Replace <code><strike></code> or <code><s></code></h2>
|
<h2 id="replace-strike-or-s">Replace <code><strike></code> or <code><s></code></h2>
|
||||||
<pre class="<!---html-->"><code>❌ <strike>striked through text</strike>
|
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||||
❌ <s>HTML 5 striked through text</s>
|
<pre class="<!---html-->"><code><strike>striked through text</strike>
|
||||||
|
<s>HTML 5 striked through text</s></code></pre>
|
||||||
✔️ <del>HTML 5 striked through text</del>
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
✔️ ~~markdown striked through text~~</code></pre>
|
<pre class="<!---html-->"><code>~~markdown striked through text~~
|
||||||
|
<del>HTML 5 striked through text</del></code></pre>
|
||||||
<div id="ins">
|
<div id="ins">
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@@ -519,35 +526,42 @@ not apply to other markdown files), <strong>PLEASE</strong> start at level three
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
<h2 id="replace-u">Replace <code><u></code></h2>
|
<h2 id="replace-u">Replace <code><u></code></h2>
|
||||||
<pre class="<!---html-->"><code>❌ <u>old tags</u>
|
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||||
✔️ <ins>HTML 5 tags</ins></code></pre>
|
<pre class="<!---html-->"><code><u>old tags</u></code></pre>
|
||||||
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
|
<pre class="<!---html-->"><code><ins>HTML 5 tags</ins></code></pre>
|
||||||
<div id="tt">
|
<div id="tt">
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<h2 id="replace-tt">Replace <code><tt></code></h2>
|
<h2 id="replace-tt">Replace <code><tt></code></h2>
|
||||||
<pre class="<!---html-->"><code>❌ <tt>obsolete HTML</tt>
|
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||||
✔️ <span style="font-family: monospace;">monospace font</span>
|
<pre class="<!---html-->"><code><tt>obsolete HTML</tt></code></pre>
|
||||||
✔️ `markdown style monospace`</code></pre>
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
|
<pre class="<!---html-->"><code><span style="font-family: monospace;">monospace font</span>
|
||||||
|
`markdown style monospace`</code></pre>
|
||||||
<div id="indent">
|
<div id="indent">
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<h2 id="indent-code-blocks-by-four-spaces-not-by-tab.">Indent code blocks by four spaces, not by TAB.</h2>
|
<h2 id="indent-code-blocks-by-four-spaces-not-by-tab.">Indent code blocks by four spaces, not by TAB.</h2>
|
||||||
<pre class="<!---sh-->"><code>❌ echo "This code block is NOT indented"</code></pre>
|
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||||
|
<pre class="<!---sh-->"><code>echo "This code block is NOT indented"</code></pre>
|
||||||
<p>We request that you indent the code block by multiples of four (4)
|
<p>We request that you indent the code block by multiples of four (4)
|
||||||
ASCII SPACES, never TAB (␉):</p>
|
ASCII SPACES, never TAB (␉):</p>
|
||||||
<pre class="<!---sh-->"><code>✔️ echo "This code block is indented by multiples of 4 spaces"
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
|
<pre class="<!---sh-->"><code> echo "This code block is indented by multiples of 4 spaces"
|
||||||
|
|
||||||
✔️ # The top level starts with a 4 ASCII space indent.
|
# The top level starts with a 4 ASCII space indent.
|
||||||
✔️ #
|
#
|
||||||
✔️ # Only indent with multiples of 4 ASCII spaces.
|
# Only indent with multiples of 4 ASCII spaces.
|
||||||
✔️ # 2nd level indent needs 8 ASCII spaces (no tabs).
|
# 2nd level indent needs 8 ASCII spaces (no tabs).
|
||||||
✔️ # 3rd level indent needs 12 ASCII spaces (no tabs).
|
# 3rd level indent needs 12 ASCII spaces (no tabs).
|
||||||
✔️ # etc.</code></pre>
|
# etc.</code></pre>
|
||||||
<p>Alternatively its possible to use <code>```</code> marks, without the initial
|
<p>Alternatively its possible to use <code>```</code> marks, without the initial
|
||||||
four (4) space indentation. This is usually the better method.</p>
|
four (4) space indentation. This is usually the better method.</p>
|
||||||
<pre class="<!---markdown-->"><code>✔️ ```
|
<p><span style="color:green">✔</span> Also correct.</p>
|
||||||
✔️ The same thing applies to any markdown block bracketed by ``` lines.
|
<pre class="<!---markdown-->"><code>```
|
||||||
✔️ ```</code></pre>
|
The same thing applies to any markdown block bracketed by ``` lines.
|
||||||
|
```</code></pre>
|
||||||
<div id="tabs">
|
<div id="tabs">
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@@ -562,23 +576,20 @@ we have discovered that ASCII TAB (␉) characters create problems when
|
|||||||
used as part of the leading whitespace within a markdown file.</p>
|
used as part of the leading whitespace within a markdown file.</p>
|
||||||
<p>If you need to indent two (2) or more levels, use multiples of four (4)
|
<p>If you need to indent two (2) or more levels, use multiples of four (4)
|
||||||
ASCII SPACES.</p>
|
ASCII SPACES.</p>
|
||||||
|
<p><span style="color:red">❌</span> Incorrect for markdown files only.</p>
|
||||||
<pre class="<!---markdown-->"><code>```
|
<pre class="<!---markdown-->"><code>```
|
||||||
❌ ␉Please do **NOT**␉use ASCII tabs␉in markdown files.
|
␉Please do **NOT**␉use ASCII tabs␉in markdown files.
|
||||||
❌ ␉␉Please do **NOT** indent markdown with ASCII tabs.
|
␉␉Please do **NOT** indent markdown with ASCII tabs.
|
||||||
|
|
||||||
❌ ␉We␉don't␉mind␉tabs␉in␉general,
|
␉We␉don't␉mind␉tabs␉in␉general,
|
||||||
❌ ␉We just ask that you NOT use them in markdown files.
|
␉We just ask that you NOT use them in markdown files.
|
||||||
```</code></pre>
|
```</code></pre>
|
||||||
<p>And to clarify, we are only talking about markdown files, not C code or
|
<p><span style="color:green">✔</span> Ok for all file types, eg. <code>.c</code>, <code>.h</code>, <code>.mk</code>, <code>.sh</code>, <strong>EXCEPT</strong> <code>.md</code> markdown files.</p>
|
||||||
any other non-markdown content:</p>
|
<pre class="<!---c-->"><code>␉printf("It is fine␉to␉use tabs in Obfuscated C code.\n");
|
||||||
<pre class="<!---c-->"><code>✔️ ␉printf("It is fine␉to␉use tabs in Obfuscated C code.\n");
|
␉␉/*␉if␉you␉wish */
|
||||||
✔️ ␉␉/*␉if␉you␉wish */
|
|
||||||
|
|
||||||
✔️ ␉// We ask that you to NOT use ASCII tab characters in your remarks.md writeup,
|
␉// We ask that you to NOT use ASCII tab characters in your remarks.md writeup,
|
||||||
✔️ ␉// or in any other markdown files within your entry, please.</code></pre>
|
␉// or in any other markdown files within your entry, please.</code></pre>
|
||||||
<p><strong>NOTE</strong>: Again, you are <strong>perfectly welcome</strong> to use ASCII TAB (␉) characters
|
|
||||||
in your C code and other non-markdown files. We simply ask that you do
|
|
||||||
<strong>NOT</strong> use any ASCII TAB (␉) characters in markdown files.</p>
|
|
||||||
<div id="code">
|
<div id="code">
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@@ -586,64 +597,57 @@ in your C code and other non-markdown files. We simply ask that you do
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
<h2 id="use-html-comments-for-code-block-language-syntax.">Use HTML comments for code block language syntax.</h2>
|
<h2 id="use-html-comments-for-code-block-language-syntax.">Use HTML comments for code block language syntax.</h2>
|
||||||
<p>We request that <a href="https://www.markdownguide.org/extended-syntax/#fenced-code-blocks">fenced markdown code blocks</a>
|
<p>We request that <a href="https://www.markdownguide.org/extended-syntax/#fenced-code-blocks">fenced markdown code blocks</a> <strong>NOT</strong> specify a language directly.</p>
|
||||||
<strong>NOT</strong> specify a language directly.</p>
|
<p><span style="color:red">❌</span> Incorrect</p>
|
||||||
<pre class="<!---markdown-->"><code>❌ ```c
|
<pre class="<!---markdown-->"><code>```c
|
||||||
❌ int main(void) {return 0;}
|
int main(void) {return 0;}
|
||||||
❌ ```</code></pre>
|
```</code></pre>
|
||||||
<p>Instead, put the language inside an HTML comment, separated from the
|
<p>Instead, put the language inside an HTML comment, separated from the
|
||||||
markdown code block starting fence by a space:</p>
|
markdown code block starting fence by a space:</p>
|
||||||
<pre class="<!---markdown-->"><code>✔️ ```<!---c-->
|
<p><span style="color:green">✔</span> Correct</p>
|
||||||
✔️ int main(void) {return 0;}
|
<pre class="<!---markdown-->"><code>```<!---c-->
|
||||||
✔️ ```</code></pre>
|
int main(void) {return 0;}
|
||||||
<p><strong>IMPORTANT</strong>: The <strong>initial</strong> <strong>` ` `</strong> must be
|
```</code></pre>
|
||||||
followed by an <strong>ASCII SPACE</strong>, and <strong>THEN</strong> an <strong>opening</strong> <strong>
|
|
||||||
<code><!---</code></strong> (a “<code><</code>”, a “<code>!</code>” and then three “<code>-</code>”s), and <strong>THEN</strong>
|
|
||||||
the <strong>language</strong> and <strong>FINALLY</strong> a <strong>closing</strong> “<code>--></code>” (two “<code>-</code>”s
|
|
||||||
followed by a “<code>></code>”).</p>
|
|
||||||
<div id="code-and-text">
|
<div id="code-and-text">
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<h2 id="ensure-blank-line-between-code-block-and-text.">Ensure blank line between code block and text.</h2>
|
<h2 id="ensure-blank-line-between-code-block-and-text.">Ensure blank line between code block and text.</h2>
|
||||||
<p>Please do <strong>NOT</strong> place text on the next line after a markdown code
|
<p><span style="color:red">❌</span> Incorrect, missing empty line after closing fence (<code>```</code>).</p>
|
||||||
block. Instead, place a blank line after the end of a markdown code
|
<pre class="<!---markdown-->"><code>```
|
||||||
block as this makes it easier to detect when markdown code blocks are
|
int
|
||||||
<strong>NOT</strong> properly indented.</p>
|
main(int foo)
|
||||||
<pre class="<!---markdown-->"><code> ```
|
{
|
||||||
int
|
return foo;
|
||||||
main(int foo)
|
}
|
||||||
{
|
```
|
||||||
return foo;
|
C compilers cannot be given a -Wno-main-arg-errors flag.</code></pre>
|
||||||
}
|
<p><span style="color:green">✔</span> Correct, has empty line between closing fence and subsequent text.</p>
|
||||||
❌ ```
|
<pre class="<!---markdown-->"><code>```
|
||||||
❌ C compilers cannot be given a -Wno-main-arg-errors flag.
|
int
|
||||||
|
main(int foo)
|
||||||
|
{
|
||||||
|
return foo;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
```
|
C compilers cannot be given a -Wno-main-arg-errors flag.</code></pre>
|
||||||
int
|
|
||||||
main(int foo)
|
|
||||||
{
|
|
||||||
return foo;
|
|
||||||
}
|
|
||||||
✔️ ```
|
|
||||||
✔️
|
|
||||||
✔️ C compilers cannot be given a -Wno-main-arg-errors flag.</code></pre>
|
|
||||||
<div id="tag-slash">
|
<div id="tag-slash">
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<h2 id="do-not-add-trailing-slash-to-void-html-tags.">Do not add trailing slash to void HTML tags.</h2>
|
<h2 id="do-not-add-trailing-slash-to-void-html-tags.">Do not add trailing slash to void HTML tags.</h2>
|
||||||
<p>Please do <strong>NOT</strong> use a trailing slash on <a href="https://github.com/validator/validator/wiki/Markup-»-Void-elements">void HTML elements</a>. See also
|
<p>The trailing slash on <a href="https://github.com/validator/validator/wiki/Markup-»-Void-elements">void HTML elements</a> has no effect and interacts
|
||||||
this note on <a href="https://github.com/validator/validator/wiki/Markup-»-Void-elements#trailing-slashes-in-void-element-start-tags-do-NOT-mark-the-start-tags-as-self-closing">trailing slashes in void-element start tags</a>.</p>
|
badly with unquoted attribute values; do not use. See also this note
|
||||||
<p>The trailing slash on void HTML elements has no effect and interacts
|
on <a href="https://github.com/validator/validator/wiki/Markup-»-Void-elements#trailing-slashes-in-void-element-start-tags-do-NOT-mark-the-start-tags-as-self-closing">trailing slashes in void-element start tags</a>.</p>
|
||||||
badly with unquoted attribute values.</p>
|
<p><span style="color:red">❌</span> Incorrect</p>
|
||||||
<pre class="<!---html-->"><code>❌ <br/>
|
<pre class="<!---html-->"><code><br/>
|
||||||
❌ <hr/>
|
<hr/>
|
||||||
❌ <img src="1984-anonymous-tattoo.jpg" alt="image of a tattoo of
|
<img src="1984-anonymous-tattoo.jpg" alt="image of a tattoo of
|
||||||
the 1984 anonymous C code" width=600 height=401 />
|
the 1984 anonymous C code" width=600 height=401 /></code></pre>
|
||||||
|
<p><span style="color:green">✔</span> Correct</p>
|
||||||
✔️ <br>
|
<pre class="<!---html-->"><code><br>
|
||||||
✔️ <hr>
|
<hr>
|
||||||
✔️ <img src="1984-anonymous-tattoo.jpg" alt="image of a tattoo of
|
<img src="1984-anonymous-tattoo.jpg" alt="image of a tattoo of
|
||||||
the 1984 anonymous C code" width=600 height=401></code></pre>
|
the 1984 anonymous C code" width=600 height=401></code></pre>
|
||||||
<div id="br">
|
<div id="br">
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@@ -651,41 +655,39 @@ badly with unquoted attribute values.</p>
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
<h2 id="do-not-use-a-trailing-backslash-outside-of-a-code-block">Do not use a trailing backslash outside of a code block</h2>
|
<h2 id="do-not-use-a-trailing-backslash-outside-of-a-code-block">Do not use a trailing backslash outside of a code block</h2>
|
||||||
<p>Unless the line is inside a markdown code block, please do <strong>NOT</strong> end
|
<p><span style="color:red">❌</span> Incorrect, do not use escaped newlines outside of a code block.</p>
|
||||||
a markdown line with a trailing backslash (<code>\</code>). Instead use a trailing
|
<pre class="<!---markdown-->"><code>In markdown,\
|
||||||
<code><br></code>.</p>
|
do NOT use trailing\
|
||||||
<pre class="<!---markdown-->"><code>❌ In markdown,\
|
backslashes outside of\
|
||||||
❌ do NOT use trailing\
|
a code block</code></pre>
|
||||||
❌ backslashes outside of\
|
<p><span style="color:green">✔</span> Correct</p>
|
||||||
❌ a code block
|
<pre class="<!---html-->"><code>In markdown,<br>
|
||||||
|
use trailing<br>
|
||||||
|
br's outside of<br>
|
||||||
|
a code block
|
||||||
|
|
||||||
✔️ In markdown,<br>
|
```
|
||||||
✔️ use trailing<br>
|
This is OK\
|
||||||
✔️ br's outside of<br>
|
inside a\
|
||||||
✔️ a code block
|
markdown code\
|
||||||
|
block
|
||||||
|
```
|
||||||
|
|
||||||
✔️ ```
|
`This is OK\`</code></pre>
|
||||||
✔️ This is OK\
|
|
||||||
✔️ inside a\
|
|
||||||
✔️ markdown code\
|
|
||||||
✔️ block
|
|
||||||
✔️ ```
|
|
||||||
|
|
||||||
✔️ `This is OK\`</code></pre>
|
|
||||||
<p>Doing it this way will prevent <code>pandoc(1)</code> from generating deprecated
|
<p>Doing it this way will prevent <code>pandoc(1)</code> from generating deprecated
|
||||||
HTML elements, such as <code><br /></code>.</p>
|
HTML elements, such as <code><br /></code>.</p>
|
||||||
<div id="img">
|
<div id="img">
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<h2 id="do-not-use-markdown-style-images">Do not use markdown style images</h2>
|
<h2 id="do-not-use-markdown-style-images">Do not use markdown style images</h2>
|
||||||
<p>Instead of using this markdown element to embed an image:</p>
|
<p><span style="color:red">❌</span> Incorrect</p>
|
||||||
<pre class="<!---markdown-->"><code>❌ 
|
<pre class="<!---markdown-->"><code></code></pre>
|
||||||
|
<p><span style="color:green">✔</span> Correct</p>
|
||||||
|
<pre class="<!---markdown-->"><code><img src="filename.png"
|
||||||
|
alt="describe the filename.png image for someone who cannot view it"
|
||||||
|
width=PIXEL_WIDTH height=PIXEL_HEIGHT>
|
||||||
|
|
||||||
✔️ <img src="filename.png"
|
Which allows for HTML <img> attributes `alt=`, `width=` and `length=`.</code></pre>
|
||||||
alt="describe the filename.png image for someone who cannot view it"
|
|
||||||
width=PIXEL_WIDTH height=PIXEL_HEIGHT>
|
|
||||||
|
|
||||||
Which allows for HTML <img> attributes `alt=`, `width=` and `length=`.</code></pre>
|
|
||||||
<p>The problem is that <code>pandoc(1)</code> generates problematic HTML from the
|
<p>The problem is that <code>pandoc(1)</code> generates problematic HTML from the
|
||||||
markdown image construct, the resulting HTML does <strong>NOT</strong> have <code>width</code>
|
markdown image construct, the resulting HTML does <strong>NOT</strong> have <code>width</code>
|
||||||
and <code>height</code> information so browsers have to slow down on rendering
|
and <code>height</code> information so browsers have to slow down on rendering
|
||||||
@@ -701,35 +703,38 @@ a line with 3 or more dashes (“<code>-</code>”s).</p>
|
|||||||
<p>Such markdown causes <code>pandoc(1)</code> to generate <code><hr /></code>. The <code><hr /></code> has
|
<p>Such markdown causes <code>pandoc(1)</code> to generate <code><hr /></code>. The <code><hr /></code> has
|
||||||
no effect in standard HTML 5 and interacts badly with unquoted attribute
|
no effect in standard HTML 5 and interacts badly with unquoted attribute
|
||||||
values.</p>
|
values.</p>
|
||||||
<pre class="<!---html-->"><code>❌ * * *
|
<p><span style="color:red">❌</span> Incorrect</p>
|
||||||
❌ - - -
|
<pre class="<!---html-->"><code>* * *
|
||||||
❌ ---
|
- - -
|
||||||
|
---</code></pre>
|
||||||
|
<p><span style="color:green">✔</span> Correct</p>
|
||||||
|
<pre class="<!---html-->"><code>Regular divider...
|
||||||
|
<hr>
|
||||||
|
|
||||||
Regular divider...
|
A short divider...
|
||||||
✔️ <hr>
|
<hr style="width:10%;text-align:left;margin-left:0"></code></pre>
|
||||||
|
|
||||||
A short divider...
|
|
||||||
✔️ <hr style="width:10%;text-align:left;margin-left:0"></code></pre>
|
|
||||||
<div id="parentheses">
|
<div id="parentheses">
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<h2 id="do-not-put-a-literal-or-in-markdown-link-titles">Do not put a literal “<code>(</code>” or “<code>)</code>” in markdown link titles</h2>
|
<h2 id="do-not-put-a-literal-or-in-markdown-link-titles">Do not put a literal “<code>(</code>” or “<code>)</code>” in markdown link titles</h2>
|
||||||
<pre class="<!---markdown-->"><code>❌ [some (text)](https://example.com/curds)
|
<p><span style="color:red">❌</span> Incorrect</p>
|
||||||
✔️ [some &lpar;text&rpar;](https://example.com/curds)
|
<pre class="<!---markdown-->"><code>[some (text)](https://example.com/curds)
|
||||||
|
[ls(1)](https://example.com/ls-man-page.1)</code></pre>
|
||||||
❌ [ls(1)](https://example.com/ls-man-page.1)
|
<p><span style="color:green">✔</span> Correct</p>
|
||||||
✔️ [ls&lpar;1&rpar;](https://example.com/ls-man-page.1)</code></pre>
|
<pre class="<!---markdown-->"><code>[some &lpar;text&rpar;](https://example.com/curds)
|
||||||
|
[ls&lpar;1&rpar;](https://example.com/ls-man-page.1)</code></pre>
|
||||||
<div id="closing-parentheses">
|
<div id="closing-parentheses">
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
<h2 id="do-not-end-markdown-links-with">Do not end markdown links with “<code>))</code>”</h2>
|
<h2 id="do-not-end-markdown-links-with">Do not end markdown links with “<code>))</code>”</h2>
|
||||||
<p>Markdown links that end in “<code>))</code>” complicate parsing and sometimes lead
|
<p>Markdown links that end in “<code>))</code>” complicate parsing and sometimes lead
|
||||||
to incorrect URLs or file paths.</p>
|
to incorrect URLs or file paths.</p>
|
||||||
<pre class="<!---markdown-->"><code>❌ [some text](https://example.com/foo_(bar))
|
<p><span style="color:red">❌</span> Incorrect</p>
|
||||||
✔️ [some text](https://example.com/foo_&lpar;bar&rpar;)
|
<pre class="<!---markdown-->"><code>[some text](https://example.com/foo_(bar))
|
||||||
|
This thing, ([some text](some/path)), is NOT ideal.</code></pre>
|
||||||
❌ This thing, ([some text](some/path)), is NOT ideal.
|
<p><span style="color:green">✔</span> Correct</p>
|
||||||
✔️ This thing, [some text](some/path), is better.</code></pre>
|
<pre class="<!---markdown-->"><code>[some text](https://example.com/foo_&lpar;bar&rpar;)
|
||||||
|
This thing, [some text](some/path), is better.</code></pre>
|
||||||
<div id="italics">
|
<div id="italics">
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@@ -738,12 +743,13 @@ to incorrect URLs or file paths.</p>
|
|||||||
Instead use an underscore (<code>_</code>). Using an asterisk can complicate
|
Instead use an underscore (<code>_</code>). Using an asterisk can complicate
|
||||||
parsing and sometimes lead to incorrect results. This can especially
|
parsing and sometimes lead to incorrect results. This can especially
|
||||||
go for when it is <strong><em>bold and italic</em></strong>.</p>
|
go for when it is <strong><em>bold and italic</em></strong>.</p>
|
||||||
<pre class="<!---markdown-->"><code>❌ *this text is italic*
|
<p><span style="color:red">❌</span> Incorrect</p>
|
||||||
✔️ _this text is italic_
|
<pre class="<!---markdown-->"><code>*this text is italic*
|
||||||
|
***this text is bold italic***</code></pre>
|
||||||
❌ ***this text is bold italic***
|
<p><span style="color:green">✔</span> Correct</p>
|
||||||
✔️ **_this text is bold italic_**
|
<pre class="<!---markdown-->"><code>_this text is italic_
|
||||||
✔️ _**this text is bold italic**_</code></pre>
|
**_this text is bold italic_**
|
||||||
|
_**this text is bold italic**_</code></pre>
|
||||||
<p><strong>BTW</strong>: the astute reader might notice that some cases of <code>*</code> for italic
|
<p><strong>BTW</strong>: the astute reader might notice that some cases of <code>*</code> for italic
|
||||||
might have slipped through. We do ask you, however, to please
|
might have slipped through. We do ask you, however, to please
|
||||||
observe this rule, as best you can.
|
observe this rule, as best you can.
|
||||||
|
|||||||
+7
-7
@@ -16810,11 +16810,11 @@
|
|||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://www.ioccc.org/markdown.html</loc>
|
<loc>https://www.ioccc.org/markdown.html</loc>
|
||||||
<lastmod>2025-11-27T15:59:15+00:00</lastmod>
|
<lastmod>2025-11-28T05:02:34+00:00</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://www.ioccc.org/markdown.md</loc>
|
<loc>https://www.ioccc.org/markdown.md</loc>
|
||||||
<lastmod>2025-11-27T15:58:56+00:00</lastmod>
|
<lastmod>2025-11-28T04:59:17+00:00</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://www.ioccc.org/news.html</loc>
|
<loc>https://www.ioccc.org/news.html</loc>
|
||||||
@@ -16826,11 +16826,11 @@
|
|||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://www.ioccc.org/next/guidelines.html</loc>
|
<loc>https://www.ioccc.org/next/guidelines.html</loc>
|
||||||
<lastmod>2025-11-27T15:58:32+00:00</lastmod>
|
<lastmod>2025-11-28T04:58:56+00:00</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://www.ioccc.org/next/guidelines.md</loc>
|
<loc>https://www.ioccc.org/next/guidelines.md</loc>
|
||||||
<lastmod>2025-11-27T15:58:32+00:00</lastmod>
|
<lastmod>2025-11-28T04:58:56+00:00</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://www.ioccc.org/next/index.html</loc>
|
<loc>https://www.ioccc.org/next/index.html</loc>
|
||||||
@@ -16870,11 +16870,11 @@
|
|||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://www.ioccc.org/next/rules.html</loc>
|
<loc>https://www.ioccc.org/next/rules.html</loc>
|
||||||
<lastmod>2025-11-27T15:59:14+00:00</lastmod>
|
<lastmod>2025-11-28T04:58:56+00:00</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://www.ioccc.org/next/rules.md</loc>
|
<loc>https://www.ioccc.org/next/rules.md</loc>
|
||||||
<lastmod>2025-11-27T15:58:56+00:00</lastmod>
|
<lastmod>2025-11-28T04:58:56+00:00</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://www.ioccc.org/next/submit.html</loc>
|
<loc>https://www.ioccc.org/next/submit.html</loc>
|
||||||
@@ -16938,7 +16938,7 @@
|
|||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://www.ioccc.org/status.html</loc>
|
<loc>https://www.ioccc.org/status.html</loc>
|
||||||
<lastmod>2025-11-27T07:15:03+00:00</lastmod>
|
<lastmod>2025-11-28T05:02:53+00:00</lastmod>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://www.ioccc.org/status.json</loc>
|
<loc>https://www.ioccc.org/status.json</loc>
|
||||||
|
|||||||
Reference in new issue
Block a user