use checkmark with no background in markdown.md
This commit is contained in:
1 parent
b19846fb4d
commit
bf93637eae
3 files changed
+50
-50
No files matched your search
+22
-22
@@ -454,7 +454,7 @@
|
|||||||
<!-- BEFORE: 1st line of markdown file: markdown.md -->
|
<!-- BEFORE: 1st line of markdown file: markdown.md -->
|
||||||
<h1 id="ioccc-29th-markdown-guidelines">IOCCC 29th Markdown Guidelines</h1>
|
<h1 id="ioccc-29th-markdown-guidelines">IOCCC 29th Markdown Guidelines</h1>
|
||||||
<h2 id="markdown-guidelines-version">Markdown Guidelines Version</h2>
|
<h2 id="markdown-guidelines-version">Markdown Guidelines Version</h2>
|
||||||
<p>These <a href="markdown.html">Markdown Guidelines</a> are version <strong>29.01 2025-11-28</strong>.</p>
|
<p>These <a href="markdown.html">Markdown Guidelines</a> are version <strong>29.02 2025-11-28</strong>.</p>
|
||||||
<h2 id="introduction">Introduction</h2>
|
<h2 id="introduction">Introduction</h2>
|
||||||
<p>The IOCCC makes extensive use of <a href="https://daringfireball.net/projects/markdown/">markdown</a>. For example, when
|
<p>The IOCCC makes extensive use of <a href="https://daringfireball.net/projects/markdown/">markdown</a>. For example, when
|
||||||
submitting to the IOCCC we have people submit remarks about their
|
submitting to the IOCCC we have people submit remarks about their
|
||||||
@@ -471,7 +471,7 @@ See the FAQ on “<a href="faq.html#remarks_md">remarks.md submission file</a>
|
|||||||
follow. Some of these relate to use of markdown directly and others relate
|
follow. Some of these relate to use of markdown directly and others relate
|
||||||
to injecting HTML into the markdown file.</p>
|
to injecting HTML into the markdown file.</p>
|
||||||
<p>In the sections below, examples will mark by ❌ for the incorrect method
|
<p>In the sections below, examples will mark by ❌ for the incorrect method
|
||||||
and ✔️ for preferred correct one.</p>
|
and ✔ for preferred correct one.</p>
|
||||||
<div id="sections">
|
<div id="sections">
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
@@ -481,7 +481,7 @@ not apply to other markdown files), <strong>PLEASE</strong> start at level three
|
|||||||
<p><span style="color:red">❌</span> Reserved in <code>remarks.md</code> only.</p>
|
<p><span style="color:red">❌</span> Reserved in <code>remarks.md</code> only.</p>
|
||||||
<pre><code> # Section Reserved
|
<pre><code> # Section Reserved
|
||||||
## Section Reserved</code></pre>
|
## Section Reserved</code></pre>
|
||||||
<p><span style="color:green">✅</span> Available every where.</p>
|
<p><span style="color:green">✔</span> Available every where.</p>
|
||||||
<pre><code> ### Section Level 3
|
<pre><code> ### Section Level 3
|
||||||
#### Section Level 4
|
#### Section Level 4
|
||||||
##### Section Level 5
|
##### Section Level 5
|
||||||
@@ -492,7 +492,7 @@ not apply to other markdown files), <strong>PLEASE</strong> start at level three
|
|||||||
<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>
|
||||||
<p><span style="color:red">❌</span> Incorrect.</p>
|
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||||
<pre><code> <a name="old_way">Section title</a></code></pre>
|
<pre><code> <a name="old_way">Section title</a></code></pre>
|
||||||
<p><span style="color:green">✅</span> Correct.</p>
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
<pre><code> <div id="new_way"></div>
|
<pre><code> <div id="new_way"></div>
|
||||||
|
|
||||||
### Section title</code></pre>
|
### Section title</code></pre>
|
||||||
@@ -502,7 +502,7 @@ not apply to other markdown files), <strong>PLEASE</strong> start at level three
|
|||||||
<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>
|
||||||
<p><span style="color:red">❌</span> Incorrect.</p>
|
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||||
<pre><code> This <a href="#link_target>HTML link text</a> works, but we prefer see below...</code></pre>
|
<pre><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>
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
<pre><code> [markdown link text](#link_target)</code></pre>
|
<pre><code> [markdown link text](#link_target)</code></pre>
|
||||||
<div id="del">
|
<div id="del">
|
||||||
|
|
||||||
@@ -514,7 +514,7 @@ not apply to other markdown files), <strong>PLEASE</strong> start at level three
|
|||||||
<p><span style="color:red">❌</span> Incorrect.</p>
|
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||||
<pre><code> <strike>striked through text</strike>
|
<pre><code> <strike>striked through text</strike>
|
||||||
<s>HTML 5 striked through text</s></code></pre>
|
<s>HTML 5 striked through text</s></code></pre>
|
||||||
<p><span style="color:green">✅</span> Correct.</p>
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
<pre><code> ~~markdown striked through text~~
|
<pre><code> ~~markdown striked through text~~
|
||||||
<del>HTML 5 striked through text</del></code></pre>
|
<del>HTML 5 striked through text</del></code></pre>
|
||||||
<div id="ins">
|
<div id="ins">
|
||||||
@@ -526,7 +526,7 @@ not apply to other markdown files), <strong>PLEASE</strong> start at level three
|
|||||||
<h2 id="replace-u">Replace <code><u></code></h2>
|
<h2 id="replace-u">Replace <code><u></code></h2>
|
||||||
<p><span style="color:red">❌</span> Incorrect.</p>
|
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||||
<pre><code> <u>old tags</u></code></pre>
|
<pre><code> <u>old tags</u></code></pre>
|
||||||
<p><span style="color:green">✅</span> Correct.</p>
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
<pre><code> <ins>HTML 5 tags</ins></code></pre>
|
<pre><code> <ins>HTML 5 tags</ins></code></pre>
|
||||||
<div id="tt">
|
<div id="tt">
|
||||||
|
|
||||||
@@ -534,7 +534,7 @@ not apply to other markdown files), <strong>PLEASE</strong> start at level three
|
|||||||
<h2 id="replace-tt">Replace <code><tt></code></h2>
|
<h2 id="replace-tt">Replace <code><tt></code></h2>
|
||||||
<p><span style="color:red">❌</span> Incorrect.</p>
|
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||||
<pre><code> <tt>obsolete HTML</tt></code></pre>
|
<pre><code> <tt>obsolete HTML</tt></code></pre>
|
||||||
<p><span style="color:green">✅</span> Correct.</p>
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
<pre><code> <span style="font-family: monospace;">monospace font</span>
|
<pre><code> <span style="font-family: monospace;">monospace font</span>
|
||||||
`markdown style monospace`</code></pre>
|
`markdown style monospace`</code></pre>
|
||||||
<div id="indent">
|
<div id="indent">
|
||||||
@@ -548,12 +548,12 @@ echo 'Please indent your code blocks with multiples of four (4) ASCII SPACES
|
|||||||
```</code></pre>
|
```</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>
|
||||||
<p><span style="color:green">✅</span> Correct.</p>
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
<pre class="<!---markdown-->"><code> ``` <!---sh-->
|
<pre class="<!---markdown-->"><code> ``` <!---sh-->
|
||||||
echo "This shell code block is indented by multiples of 4 spaces"
|
echo "This shell code block is indented by multiples of 4 spaces"
|
||||||
```</code></pre>
|
```</code></pre>
|
||||||
<p>If you need to intent more than one level, use multiples of 4 ASCII spaces (no tabs):</p>
|
<p>If you need to intent more than one level, use multiples of 4 ASCII spaces (no tabs):</p>
|
||||||
<p><span style="color:green">✅</span> Also Correct.</p>
|
<p><span style="color:green">✔</span> Also Correct.</p>
|
||||||
<pre class="<!---markdown-->"><code> ``` <!---sh-->
|
<pre class="<!---markdown-->"><code> ``` <!---sh-->
|
||||||
echo "This shell code block is indented by multiples of 4 spaces"
|
echo "This shell code block is indented by multiples of 4 spaces"
|
||||||
|
|
||||||
@@ -567,12 +567,12 @@ ASCII SPACES, never TAB (␉):</p>
|
|||||||
```</code></pre>
|
```</code></pre>
|
||||||
<p>While it is possible to use 3 backticks (```) without the initial
|
<p>While it is possible to use 3 backticks (```) without the initial
|
||||||
four (4) space indentation, we <strong>prefer</strong> that you multiples of 4 spaces if possible:</p>
|
four (4) space indentation, we <strong>prefer</strong> that you multiples of 4 spaces if possible:</p>
|
||||||
<p><span style="color:green">✅</span> Preferred.</p>
|
<p><span style="color:green">✔</span> Preferred.</p>
|
||||||
<pre class="<!---markdown-->"><code> ```
|
<pre class="<!---markdown-->"><code> ```
|
||||||
Intent text by multiples of 4 spaces if possible.
|
Intent text by multiples of 4 spaces if possible.
|
||||||
```</code></pre>
|
```</code></pre>
|
||||||
<p>A reasonable exception to the rule is when are displaying C:</p>
|
<p>A reasonable exception to the rule is when are displaying C:</p>
|
||||||
<p><span style="color:green">✅</span> OK for C.</p>
|
<p><span style="color:green">✔</span> OK for C.</p>
|
||||||
<pre class="<!---markdown-->"><code> ``` <!---c-->
|
<pre class="<!---markdown-->"><code> ``` <!---c-->
|
||||||
/* not intending C code is OK */
|
/* not intending C code is OK */
|
||||||
int
|
int
|
||||||
@@ -603,7 +603,7 @@ ASCII SPACES.</p>
|
|||||||
␉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><span style="color:green">✅</span> OK for all file types, e.g., <code>.c</code>, <code>.h</code>, <code>.mk</code>, <code>.sh</code>, <strong>EXCEPT</strong> <code>.md</code> markdown files.</p>
|
<p><span style="color:green">✔</span> OK for all file types, e.g., <code>.c</code>, <code>.h</code>, <code>.mk</code>, <code>.sh</code>, <strong>EXCEPT</strong> <code>.md</code> markdown files.</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 */
|
||||||
|
|
||||||
@@ -624,7 +624,7 @@ ASCII SPACES.</p>
|
|||||||
```</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>
|
||||||
<p><span style="color:green">✅</span> Correct.</p>
|
<p><span style="color:green">✔</span> Correct.</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>
|
||||||
@@ -650,7 +650,7 @@ and the start of the HTML comment!</p>
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
C compilers cannot be given a -Wno-main-arg-errors flag.</code></pre>
|
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>
|
<p><span style="color:green">✔</span> Correct, has empty line between closing fence and subsequent text.</p>
|
||||||
<pre class="<!---markdown-->"><code> ``` <!---c-->
|
<pre class="<!---markdown-->"><code> ``` <!---c-->
|
||||||
/* The C compiler will insist in flagging this an error, unfortunately */
|
/* The C compiler will insist in flagging this an error, unfortunately */
|
||||||
int
|
int
|
||||||
@@ -673,7 +673,7 @@ on <a href="https://github.com/validator/validator/wiki/Markup-»-Void-elements#
|
|||||||
<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>
|
||||||
<p><span style="color:green">✅</span> Correct.</p>
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
<pre><code> <br>
|
<pre><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
|
||||||
@@ -690,7 +690,7 @@ on <a href="https://github.com/validator/validator/wiki/Markup-»-Void-elements#
|
|||||||
do NOT use trailing\
|
do NOT use trailing\
|
||||||
backslashes outside of\
|
backslashes outside of\
|
||||||
a code block</code></pre>
|
a code block</code></pre>
|
||||||
<p><span style="color:green">✅</span> Correct.</p>
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
<pre class="<!---html-->"><code> In markdown,<br>
|
<pre class="<!---html-->"><code> In markdown,<br>
|
||||||
use trailing<br>
|
use trailing<br>
|
||||||
br's outside of<br>
|
br's outside of<br>
|
||||||
@@ -712,7 +712,7 @@ HTML elements, such as <code><br /></code>.</p>
|
|||||||
<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><span style="color:red">❌</span> Incorrect.</p>
|
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||||
<pre><code> </code></pre>
|
<pre><code> </code></pre>
|
||||||
<p><span style="color:green">✅</span> Correct.</p>
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
<pre><code> <img src="filename.png"
|
<pre><code> <img src="filename.png"
|
||||||
alt="describe the filename.png image for someone who cannot view it"
|
alt="describe the filename.png image for someone who cannot view it"
|
||||||
width=PIXEL_WIDTH height=PIXEL_HEIGHT>
|
width=PIXEL_WIDTH height=PIXEL_HEIGHT>
|
||||||
@@ -737,7 +737,7 @@ values.</p>
|
|||||||
<pre><code> * * *
|
<pre><code> * * *
|
||||||
- - -
|
- - -
|
||||||
---</code></pre>
|
---</code></pre>
|
||||||
<p><span style="color:green">✅</span> Correct.</p>
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
<pre><code> Regular divider...
|
<pre><code> Regular divider...
|
||||||
<hr>
|
<hr>
|
||||||
|
|
||||||
@@ -750,7 +750,7 @@ values.</p>
|
|||||||
<p><span style="color:red">❌</span> Incorrect.</p>
|
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||||
<pre><code> [some (text)](https://example.com/curds)
|
<pre><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)</code></pre>
|
||||||
<p><span style="color:green">✅</span> Correct.</p>
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
<pre><code> [some &lpar;text&rpar;](https://example.com/curds)
|
<pre><code> [some &lpar;text&rpar;](https://example.com/curds)
|
||||||
[ls&lpar;1&rpar;](https://example.com/ls-man-page.1)</code></pre>
|
[ls&lpar;1&rpar;](https://example.com/ls-man-page.1)</code></pre>
|
||||||
<div id="closing-parentheses">
|
<div id="closing-parentheses">
|
||||||
@@ -762,7 +762,7 @@ to incorrect URLs or file paths.</p>
|
|||||||
<p><span style="color:red">❌</span> Incorrect.</p>
|
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||||
<pre><code> [some text](https://example.com/foo_(bar))
|
<pre><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.</code></pre>
|
||||||
<p><span style="color:green">✅</span> Correct.</p>
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
<pre><code> [some text](https://example.com/foo_&lpar;bar&rpar;)
|
<pre><code> [some text](https://example.com/foo_&lpar;bar&rpar;)
|
||||||
This thing, [some text](some/path), is better.</code></pre>
|
This thing, [some text](some/path), is better.</code></pre>
|
||||||
<div id="italics">
|
<div id="italics">
|
||||||
@@ -776,7 +776,7 @@ go for when it is <strong><em>bold and italic</em></strong>.</p>
|
|||||||
<p><span style="color:red">❌</span> Incorrect.</p>
|
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||||
<pre><code> *this text is italic*
|
<pre><code> *this text is italic*
|
||||||
***this text is bold italic***</code></pre>
|
***this text is bold italic***</code></pre>
|
||||||
<p><span style="color:green">✅</span> Correct.</p>
|
<p><span style="color:green">✔</span> Correct.</p>
|
||||||
<pre><code> _this text is italic_
|
<pre><code> _this text is italic_
|
||||||
**_this text is bold italic_**
|
**_this text is bold italic_**
|
||||||
_**this text is bold italic**_</code></pre>
|
_**this text is bold italic**_</code></pre>
|
||||||
|
|||||||
+22
-22
@@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
## Markdown Guidelines Version
|
## Markdown Guidelines Version
|
||||||
|
|
||||||
These [Markdown Guidelines](markdown.html) are version **29.01 2025-11-28**.
|
These [Markdown Guidelines](markdown.html) are version **29.02 2025-11-28**.
|
||||||
|
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
@@ -26,7 +26,7 @@ follow. Some of these relate to use of markdown directly and others relate
|
|||||||
to injecting HTML into the markdown file.
|
to injecting HTML into the markdown file.
|
||||||
|
|
||||||
In the sections below, examples will mark by ❌ for the incorrect method
|
In the sections below, examples will mark by ❌ for the incorrect method
|
||||||
and ✔️ for preferred correct one.
|
and ✔ for preferred correct one.
|
||||||
|
|
||||||
|
|
||||||
<div id="sections"></div>
|
<div id="sections"></div>
|
||||||
@@ -43,7 +43,7 @@ not apply to other markdown files), **PLEASE** start at level three up to level
|
|||||||
## Section Reserved
|
## Section Reserved
|
||||||
```
|
```
|
||||||
|
|
||||||
<span style="color:green">✅</span> Available every where.
|
<span style="color:green">✔</span> Available every where.
|
||||||
```
|
```
|
||||||
### Section Level 3
|
### Section Level 3
|
||||||
#### Section Level 4
|
#### Section Level 4
|
||||||
@@ -62,7 +62,7 @@ not apply to other markdown files), **PLEASE** start at level three up to level
|
|||||||
<a name="old_way">Section title</a>
|
<a name="old_way">Section title</a>
|
||||||
```
|
```
|
||||||
|
|
||||||
<span style="color:green">✅</span> Correct.
|
<span style="color:green">✔</span> Correct.
|
||||||
``` <!---html-->
|
``` <!---html-->
|
||||||
<div id="new_way"></div>
|
<div id="new_way"></div>
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ not apply to other markdown files), **PLEASE** start at level three up to level
|
|||||||
This <a href="#link_target>HTML link text</a> works, but we prefer see below...
|
This <a href="#link_target>HTML link text</a> works, but we prefer see below...
|
||||||
```
|
```
|
||||||
|
|
||||||
<span style="color:green">✅</span> Correct.
|
<span style="color:green">✔</span> Correct.
|
||||||
``` <!---html-->
|
``` <!---html-->
|
||||||
[markdown link text](#link_target)
|
[markdown link text](#link_target)
|
||||||
```
|
```
|
||||||
@@ -97,7 +97,7 @@ not apply to other markdown files), **PLEASE** start at level three up to level
|
|||||||
<s>HTML 5 striked through text</s>
|
<s>HTML 5 striked through text</s>
|
||||||
```
|
```
|
||||||
|
|
||||||
<span style="color:green">✅</span> Correct.
|
<span style="color:green">✔</span> Correct.
|
||||||
``` <!---html-->
|
``` <!---html-->
|
||||||
~~markdown striked through text~~
|
~~markdown striked through text~~
|
||||||
<del>HTML 5 striked through text</del>
|
<del>HTML 5 striked through text</del>
|
||||||
@@ -114,7 +114,7 @@ not apply to other markdown files), **PLEASE** start at level three up to level
|
|||||||
<u>old tags</u>
|
<u>old tags</u>
|
||||||
```
|
```
|
||||||
|
|
||||||
<span style="color:green">✅</span> Correct.
|
<span style="color:green">✔</span> Correct.
|
||||||
``` <!---html-->
|
``` <!---html-->
|
||||||
<ins>HTML 5 tags</ins>
|
<ins>HTML 5 tags</ins>
|
||||||
```
|
```
|
||||||
@@ -130,7 +130,7 @@ not apply to other markdown files), **PLEASE** start at level three up to level
|
|||||||
<tt>obsolete HTML</tt>
|
<tt>obsolete HTML</tt>
|
||||||
```
|
```
|
||||||
|
|
||||||
<span style="color:green">✅</span> Correct.
|
<span style="color:green">✔</span> Correct.
|
||||||
``` <!---html-->
|
``` <!---html-->
|
||||||
<span style="font-family: monospace;">monospace font</span>
|
<span style="font-family: monospace;">monospace font</span>
|
||||||
`markdown style monospace`
|
`markdown style monospace`
|
||||||
@@ -153,7 +153,7 @@ echo 'Please indent your code blocks with multiples of four (4) ASCII SPACES!"
|
|||||||
We request that you indent the code block by multiples of four (4)
|
We request that you indent the code block by multiples of four (4)
|
||||||
ASCII SPACES, never TAB (␉):
|
ASCII SPACES, never TAB (␉):
|
||||||
|
|
||||||
<span style="color:green">✅</span> Correct.
|
<span style="color:green">✔</span> Correct.
|
||||||
```` <!---markdown-->
|
```` <!---markdown-->
|
||||||
``` <!---sh-->
|
``` <!---sh-->
|
||||||
echo "This shell code block is indented by multiples of 4 spaces"
|
echo "This shell code block is indented by multiples of 4 spaces"
|
||||||
@@ -162,7 +162,7 @@ ASCII SPACES, never TAB (␉):
|
|||||||
|
|
||||||
If you need to intent more than one level, use multiples of 4 ASCII spaces (no tabs):
|
If you need to intent more than one level, use multiples of 4 ASCII spaces (no tabs):
|
||||||
|
|
||||||
<span style="color:green">✅</span> Also Correct.
|
<span style="color:green">✔</span> Also Correct.
|
||||||
```` <!---markdown-->
|
```` <!---markdown-->
|
||||||
``` <!---sh-->
|
``` <!---sh-->
|
||||||
echo "This shell code block is indented by multiples of 4 spaces"
|
echo "This shell code block is indented by multiples of 4 spaces"
|
||||||
@@ -180,7 +180,7 @@ If you need to intent more than one level, use multiples of 4 ASCII spaces (no t
|
|||||||
While it is possible to use 3 backticks (```) without the initial
|
While it is possible to use 3 backticks (```) without the initial
|
||||||
four (4) space indentation, we **prefer** that you multiples of 4 spaces if possible:
|
four (4) space indentation, we **prefer** that you multiples of 4 spaces if possible:
|
||||||
|
|
||||||
<span style="color:green">✅</span> Preferred.
|
<span style="color:green">✔</span> Preferred.
|
||||||
```` <!---markdown-->
|
```` <!---markdown-->
|
||||||
```
|
```
|
||||||
Intent text by multiples of 4 spaces if possible.
|
Intent text by multiples of 4 spaces if possible.
|
||||||
@@ -189,7 +189,7 @@ four (4) space indentation, we **prefer** that you multiples of 4 spaces if poss
|
|||||||
|
|
||||||
A reasonable exception to the rule is when are displaying C:
|
A reasonable exception to the rule is when are displaying C:
|
||||||
|
|
||||||
<span style="color:green">✅</span> OK for C.
|
<span style="color:green">✔</span> OK for C.
|
||||||
|
|
||||||
```` <!---markdown-->
|
```` <!---markdown-->
|
||||||
``` <!---c-->
|
``` <!---c-->
|
||||||
@@ -229,7 +229,7 @@ ASCII SPACES.
|
|||||||
```
|
```
|
||||||
````
|
````
|
||||||
|
|
||||||
<span style="color:green">✅</span> OK for all file types, e.g., `.c`, `.h`, `.mk`, `.sh`, **EXCEPT** `.md` markdown files.
|
<span style="color:green">✔</span> OK for all file types, e.g., `.c`, `.h`, `.mk`, `.sh`, **EXCEPT** `.md` markdown files.
|
||||||
```` <!---c-->
|
```` <!---c-->
|
||||||
␉printf("It is fine␉to␉use tabs in Obfuscated C code.\n");
|
␉printf("It is fine␉to␉use tabs in Obfuscated C code.\n");
|
||||||
␉␉/*␉if␉you␉wish */
|
␉␉/*␉if␉you␉wish */
|
||||||
@@ -258,7 +258,7 @@ We request that [fenced markdown code blocks](https://www.markdownguide.org/exte
|
|||||||
Instead, put the language inside an HTML comment, separated from the
|
Instead, put the language inside an HTML comment, separated from the
|
||||||
markdown code block starting fence by a space:
|
markdown code block starting fence by a space:
|
||||||
|
|
||||||
<span style="color:green">✅</span> Correct.
|
<span style="color:green">✔</span> Correct.
|
||||||
```` <!---markdown-->
|
```` <!---markdown-->
|
||||||
``` <!---c-->
|
``` <!---c-->
|
||||||
int main(void) {return 0;}
|
int main(void) {return 0;}
|
||||||
@@ -293,7 +293,7 @@ and the start of the HTML comment!
|
|||||||
C compilers cannot be given a -Wno-main-arg-errors flag.
|
C compilers cannot be given a -Wno-main-arg-errors flag.
|
||||||
````
|
````
|
||||||
|
|
||||||
<span style="color:green">✅</span> Correct, has empty line between closing fence and subsequent text.
|
<span style="color:green">✔</span> Correct, has empty line between closing fence and subsequent text.
|
||||||
```` <!---markdown-->
|
```` <!---markdown-->
|
||||||
``` <!---c-->
|
``` <!---c-->
|
||||||
/* The C compiler will insist in flagging this an error, unfortunately */
|
/* The C compiler will insist in flagging this an error, unfortunately */
|
||||||
@@ -326,7 +326,7 @@ on [trailing slashes in void-element start tags](https://github.com/validator/va
|
|||||||
the 1984 anonymous C code" width=600 height=401 />
|
the 1984 anonymous C code" width=600 height=401 />
|
||||||
```
|
```
|
||||||
|
|
||||||
<span style="color:green">✅</span> Correct.
|
<span style="color:green">✔</span> Correct.
|
||||||
``` <!---html-->
|
``` <!---html-->
|
||||||
<br>
|
<br>
|
||||||
<hr>
|
<hr>
|
||||||
@@ -348,7 +348,7 @@ on [trailing slashes in void-element start tags](https://github.com/validator/va
|
|||||||
a code block
|
a code block
|
||||||
```
|
```
|
||||||
|
|
||||||
<span style="color:green">✅</span> Correct.
|
<span style="color:green">✔</span> Correct.
|
||||||
```` <!---html-->
|
```` <!---html-->
|
||||||
In markdown,<br>
|
In markdown,<br>
|
||||||
use trailing<br>
|
use trailing<br>
|
||||||
@@ -379,7 +379,7 @@ HTML elements, such as `<br />`.
|
|||||||

|

|
||||||
```
|
```
|
||||||
|
|
||||||
<span style="color:green">✅</span> Correct.
|
<span style="color:green">✔</span> Correct.
|
||||||
``` <!---markdown-->
|
``` <!---markdown-->
|
||||||
<img src="filename.png"
|
<img src="filename.png"
|
||||||
alt="describe the filename.png image for someone who cannot view it"
|
alt="describe the filename.png image for someone who cannot view it"
|
||||||
@@ -416,7 +416,7 @@ values.
|
|||||||
---
|
---
|
||||||
```
|
```
|
||||||
|
|
||||||
<span style="color:green">✅</span> Correct.
|
<span style="color:green">✔</span> Correct.
|
||||||
``` <!---html-->
|
``` <!---html-->
|
||||||
Regular divider...
|
Regular divider...
|
||||||
<hr>
|
<hr>
|
||||||
@@ -437,7 +437,7 @@ values.
|
|||||||
[ls(1)](https://example.com/ls-man-page.1)
|
[ls(1)](https://example.com/ls-man-page.1)
|
||||||
```
|
```
|
||||||
|
|
||||||
<span style="color:green">✅</span> Correct.
|
<span style="color:green">✔</span> Correct.
|
||||||
``` <!---markdown-->
|
``` <!---markdown-->
|
||||||
[some (text)](https://example.com/curds)
|
[some (text)](https://example.com/curds)
|
||||||
[ls(1)](https://example.com/ls-man-page.1)
|
[ls(1)](https://example.com/ls-man-page.1)
|
||||||
@@ -458,7 +458,7 @@ to incorrect URLs or file paths.
|
|||||||
This thing, ([some text](some/path)), is NOT ideal.
|
This thing, ([some text](some/path)), is NOT ideal.
|
||||||
```
|
```
|
||||||
|
|
||||||
<span style="color:green">✅</span> Correct.
|
<span style="color:green">✔</span> Correct.
|
||||||
``` <!---markdown-->
|
``` <!---markdown-->
|
||||||
[some text](https://example.com/foo_(bar))
|
[some text](https://example.com/foo_(bar))
|
||||||
This thing, [some text](some/path), is better.
|
This thing, [some text](some/path), is better.
|
||||||
@@ -481,7 +481,7 @@ go for when it is **_bold and italic_**.
|
|||||||
***this text is bold italic***
|
***this text is bold italic***
|
||||||
```
|
```
|
||||||
|
|
||||||
<span style="color:green">✅</span> Correct.
|
<span style="color:green">✔</span> Correct.
|
||||||
``` <!---markdown-->
|
``` <!---markdown-->
|
||||||
_this text is italic_
|
_this text is italic_
|
||||||
**_this text is bold italic_**
|
**_this text is bold italic_**
|
||||||
|
|||||||
+6
-6
@@ -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-28T16:46:49+00:00</lastmod>
|
<lastmod>2025-11-29T04:28:46+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-28T16:46:44+00:00</lastmod>
|
<lastmod>2025-11-29T04:30:44+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-28T04:58:56+00:00</lastmod>
|
<lastmod>2025-11-29T04:32:18+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-28T04:58:56+00:00</lastmod>
|
<lastmod>2025-11-29T04:32:18+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-28T04:58:56+00:00</lastmod>
|
<lastmod>2025-11-29T04:32:18+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-28T04:58:56+00:00</lastmod>
|
<lastmod>2025-11-29T04:32:18+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>
|
||||||
|
|||||||
Reference in new issue
Block a user