use checkmark with no background in markdown.md
This commit is contained in:
Landon Curt Noll committed
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 -->
|
||||
<h1 id="ioccc-29th-markdown-guidelines">IOCCC 29th Markdown Guidelines</h1>
|
||||
<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>
|
||||
<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
|
||||
@@ -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
|
||||
to injecting HTML into the markdown file.</p>
|
||||
<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>
|
||||
@@ -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>
|
||||
<pre><code> # Section Reserved
|
||||
## 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
|
||||
#### Section Level 4
|
||||
##### 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>
|
||||
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||
<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>
|
||||
|
||||
### 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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<pre><code> <strike>striked through text</strike>
|
||||
<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~~
|
||||
<del>HTML 5 striked through text</del></code></pre>
|
||||
<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>
|
||||
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||
<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>
|
||||
<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>
|
||||
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||
<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>
|
||||
`markdown style monospace`</code></pre>
|
||||
<div id="indent">
|
||||
@@ -548,12 +548,12 @@ echo 'Please indent your code blocks with multiples of four (4) ASCII SPACES
|
||||
```</code></pre>
|
||||
<p>We request that you indent the code block by multiples of four (4)
|
||||
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-->
|
||||
echo "This shell code block is indented by multiples of 4 spaces"
|
||||
```</code></pre>
|
||||
<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-->
|
||||
echo "This shell code block is indented by multiples of 4 spaces"
|
||||
|
||||
@@ -567,12 +567,12 @@ ASCII SPACES, never TAB (␉):</p>
|
||||
```</code></pre>
|
||||
<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>
|
||||
<p><span style="color:green">✅</span> Preferred.</p>
|
||||
<p><span style="color:green">✔</span> Preferred.</p>
|
||||
<pre class="<!---markdown-->"><code> ```
|
||||
Intent text by multiples of 4 spaces if possible.
|
||||
```</code></pre>
|
||||
<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-->
|
||||
/* not intending C code is OK */
|
||||
int
|
||||
@@ -603,7 +603,7 @@ ASCII SPACES.</p>
|
||||
␉We␉don't␉mind␉tabs␉in␉general,
|
||||
␉We just ask that you NOT use them in markdown files.
|
||||
```</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");
|
||||
␉␉/*␉if␉you␉wish */
|
||||
|
||||
@@ -624,7 +624,7 @@ ASCII SPACES.</p>
|
||||
```</code></pre>
|
||||
<p>Instead, put the language inside an HTML comment, separated from the
|
||||
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-->
|
||||
int main(void) {return 0;}
|
||||
```</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>
|
||||
<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-->
|
||||
/* The C compiler will insist in flagging this an error, unfortunately */
|
||||
int
|
||||
@@ -673,7 +673,7 @@ on <a href="https://github.com/validator/validator/wiki/Markup-»-Void-elements#
|
||||
<hr/>
|
||||
<img src="1984-anonymous-tattoo.jpg" alt="image of a tattoo of
|
||||
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>
|
||||
<hr>
|
||||
<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\
|
||||
backslashes outside of\
|
||||
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>
|
||||
use trailing<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>
|
||||
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||
<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"
|
||||
alt="describe the filename.png image for someone who cannot view it"
|
||||
width=PIXEL_WIDTH height=PIXEL_HEIGHT>
|
||||
@@ -737,7 +737,7 @@ values.</p>
|
||||
<pre><code> * * *
|
||||
- - -
|
||||
---</code></pre>
|
||||
<p><span style="color:green">✅</span> Correct.</p>
|
||||
<p><span style="color:green">✔</span> Correct.</p>
|
||||
<pre><code> Regular divider...
|
||||
<hr>
|
||||
|
||||
@@ -750,7 +750,7 @@ values.</p>
|
||||
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||
<pre><code> [some (text)](https://example.com/curds)
|
||||
[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)
|
||||
[ls&lpar;1&rpar;](https://example.com/ls-man-page.1)</code></pre>
|
||||
<div id="closing-parentheses">
|
||||
@@ -762,7 +762,7 @@ to incorrect URLs or file paths.</p>
|
||||
<p><span style="color:red">❌</span> Incorrect.</p>
|
||||
<pre><code> [some text](https://example.com/foo_(bar))
|
||||
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;)
|
||||
This thing, [some text](some/path), is better.</code></pre>
|
||||
<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>
|
||||
<pre><code> *this text is italic*
|
||||
***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_
|
||||
**_this text is bold italic_**
|
||||
_**this text is bold italic**_</code></pre>
|
||||
|
||||
Reference in new issue
Block a user