mirror/ioccc
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #2432 from xexyl/consistency

Browse Source
This commit is contained in:
Landon Curt Noll authored and GitHub committed 2024-06-15 12:54:57 -07:00
2 parents 752682b5c5 a98d8397a4
commit 2fb68c926f
22 files changed
+116 -118
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

CODE_OF_CONDUCT.html
+4 -4
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./bugs.html" class="sub-item-link"> <a href="./bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./next/index.html" class="sub-item-link"> <a href="./next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./bugs.html"> <a class="mobile-submenu-item" href="./bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./next/index.html"> <a class="mobile-submenu-item" href="./next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="./news.html"> <a class="mobile-submenu-item" href="./news.html">
README.html
+4 -4
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./bugs.html" class="sub-item-link"> <a href="./bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./next/index.html" class="sub-item-link"> <a href="./next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./bugs.html"> <a class="mobile-submenu-item" href="./bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./next/index.html"> <a class="mobile-submenu-item" href="./next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="./news.html"> <a class="mobile-submenu-item" href="./news.html">
archive/historic/index.html
+4 -4
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="../../bugs.html" class="sub-item-link"> <a href="../../bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="../../next/index.html" class="sub-item-link"> <a href="../../next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="../../bugs.html"> <a class="mobile-submenu-item" href="../../bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="../../next/index.html"> <a class="mobile-submenu-item" href="../../next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="../../news.html"> <a class="mobile-submenu-item" href="../../news.html">
bin/index.html
+4 -4
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="../bugs.html" class="sub-item-link"> <a href="../bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="../next/index.html" class="sub-item-link"> <a href="../next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="../bugs.html"> <a class="mobile-submenu-item" href="../bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="../next/index.html"> <a class="mobile-submenu-item" href="../next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="../news.html"> <a class="mobile-submenu-item" href="../news.html">
bugs.html
+4 -4
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./bugs.html" class="sub-item-link"> <a href="./bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./next/index.html" class="sub-item-link"> <a href="./next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./bugs.html"> <a class="mobile-submenu-item" href="./bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./next/index.html"> <a class="mobile-submenu-item" href="./next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="./news.html"> <a class="mobile-submenu-item" href="./news.html">
contact.html
+4 -4
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./bugs.html" class="sub-item-link"> <a href="./bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./next/index.html" class="sub-item-link"> <a href="./next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./bugs.html"> <a class="mobile-submenu-item" href="./bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./next/index.html"> <a class="mobile-submenu-item" href="./next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="./news.html"> <a class="mobile-submenu-item" href="./news.html">
faq.html
+4 -4
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./bugs.html" class="sub-item-link"> <a href="./bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./next/index.html" class="sub-item-link"> <a href="./next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./bugs.html"> <a class="mobile-submenu-item" href="./bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./next/index.html"> <a class="mobile-submenu-item" href="./next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="./news.html"> <a class="mobile-submenu-item" href="./news.html">
inc/index.html
+4 -4
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="../bugs.html" class="sub-item-link"> <a href="../bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="../next/index.html" class="sub-item-link"> <a href="../next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="../bugs.html"> <a class="mobile-submenu-item" href="../bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="../next/index.html"> <a class="mobile-submenu-item" href="../next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="../news.html"> <a class="mobile-submenu-item" href="../news.html">
inc/topbar.default.html
+4 -4
View File
@@ -36,7 +36,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="%%DOCROOT_SLASH%%bugs.html" class="sub-item-link"> <a href="%%DOCROOT_SLASH%%bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -62,7 +62,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="%%DOCROOT_SLASH%%next/index.html" class="sub-item-link"> <a href="%%DOCROOT_SLASH%%next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -192,7 +192,7 @@
</a> </a>
<a class="mobile-submenu-item" href="%%DOCROOT_SLASH%%bugs.html"> <a class="mobile-submenu-item" href="%%DOCROOT_SLASH%%bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -210,7 +210,7 @@
</a> </a>
<a class="mobile-submenu-item" href="%%DOCROOT_SLASH%%next/index.html"> <a class="mobile-submenu-item" href="%%DOCROOT_SLASH%%next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="%%DOCROOT_SLASH%%news.html"> <a class="mobile-submenu-item" href="%%DOCROOT_SLASH%%news.html">
index.html
+4 -4
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./bugs.html" class="sub-item-link"> <a href="./bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./next/index.html" class="sub-item-link"> <a href="./next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./bugs.html"> <a class="mobile-submenu-item" href="./bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./next/index.html"> <a class="mobile-submenu-item" href="./next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="./news.html"> <a class="mobile-submenu-item" href="./news.html">
judges.html
+4 -4
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./bugs.html" class="sub-item-link"> <a href="./bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./next/index.html" class="sub-item-link"> <a href="./next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./bugs.html"> <a class="mobile-submenu-item" href="./bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./next/index.html"> <a class="mobile-submenu-item" href="./next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="./news.html"> <a class="mobile-submenu-item" href="./news.html">
license.html
+4 -4
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./bugs.html" class="sub-item-link"> <a href="./bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./next/index.html" class="sub-item-link"> <a href="./next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./bugs.html"> <a class="mobile-submenu-item" href="./bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./next/index.html"> <a class="mobile-submenu-item" href="./next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="./news.html"> <a class="mobile-submenu-item" href="./news.html">
markdown.html
+19 -20
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./bugs.html" class="sub-item-link"> <a href="./bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./next/index.html" class="sub-item-link"> <a href="./next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./bugs.html"> <a class="mobile-submenu-item" href="./bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./next/index.html"> <a class="mobile-submenu-item" href="./next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="./news.html"> <a class="mobile-submenu-item" href="./news.html">
@@ -384,22 +384,22 @@
<!-- BEFORE: 1st line of markdown file: markdown.md --> <!-- BEFORE: 1st line of markdown file: markdown.md -->
<h1 id="ioccc-markdown-best-practices">IOCCC markdown best practices</h1> <h1 id="ioccc-markdown-best-practices">IOCCC markdown best practices</h1>
<p>The IOCCC makes extensive use of <a href="https://daringfireball.net/projects/markdown/">markdown</a>. <p>The IOCCC makes extensive use of <a href="https://daringfireball.net/projects/markdown/">markdown</a>.
For example, we <a href="faq.html#submit">submitting to the IOCCC</a>, we have people For example, when <a href="faq.html#submit">submitting to the IOCCC</a>, we have people
to submit remarks about entry in markdown format. Every submit remarks about their entry in markdown format. Every
<a href="years.html">winning IOCCC entry</a> uses a <code>README.md</code> markdown file <a href="years.html">winning IOCCC entry</a> uses a <code>README.md</code> markdown file
as the basis for forming the <code>index.html</code> web page for that entry. as the basis for forming the <code>index.html</code> web page for that entry.
All generated HTML pages on the <a href="https://www.ioccc.org/index.html">Official IOCCC website</a> All generated HTML pages on the <a href="https://www.ioccc.org/index.html">Official IOCCC website</a>
start with some markdown content.</p> start with some markdown content.</p>
<p>See the <a href="https://www.markdownguide.org/basic-syntax">markdown syntax</a> guide. <p>See the <a href="https://www.markdownguide.org/basic-syntax">markdown syntax</a> guide.
See also <a href="https://spec.commonmark.org/current/">CommonMark Spec</a>.</p> See also the <a href="https://spec.commonmark.org/current/">CommonMark Spec</a>.</p>
<p>Nevertheless, the IOCCC does have certain practices that we ask authors to follow. <p>Nevertheless, the IOCCC does have certain practices that we ask authors to follow.
Some these relate to use of markdown directly, others relate to injecting HTML Some of these relate to use of markdown directly and others relate to injecting HTML
into the markdown file.</p> into the markdown file.</p>
<p>In particular there are things we ask people to please do <strong>NOT</strong> use in <p>In particular there are things we ask people to please <strong>NOT</strong> use in
markdown files for the IOCCC:</p> markdown files for the IOCCC:</p>
<h2 id="please-do-not-use-name-attributes-in-html-a-..-hyperlink-elements">Please do NOT use name attributes in HTML <code>&lt;a ..&gt;</code> hyperlink elements</h2> <h2 id="please-do-not-use-name-attributes-in-html-a-..-hyperlink-elements">Please do NOT use name attributes in HTML <code>&lt;a ..&gt;</code> hyperlink elements</h2>
<p>Please do <strong>NOT</strong> use the HTML construct:</p> <p>Please do <strong>NOT</strong> use the HTML construct:</p>
<pre><code> &lt;a name=&quot;string&quot;&gt;...&lt;/a&gt; &lt;=== no thank you</code></pre> <pre><code> &lt;a name=&quot;string&quot;&gt;...&lt;/a&gt; &lt;!-- no thank you --&gt;</code></pre>
<p>as those are <strong>NOT</strong> part of the HTML 5 standard.</p> <p>as those are <strong>NOT</strong> part of the HTML 5 standard.</p>
<p>Instead use:</p> <p>Instead use:</p>
<pre><code> &lt;div id=&quot;string&quot;&gt;...&lt;/div&gt;</code></pre> <pre><code> &lt;div id=&quot;string&quot;&gt;...&lt;/div&gt;</code></pre>
@@ -409,26 +409,26 @@ encapsulates the HTML you want to name: i.e., the target of some
for the given page URL.</p> for the given page URL.</p>
<p>There are certain HTML Elements that cannot have internal <code>&lt;div id="string"&gt;...&lt;/div&gt;</code>.</p> <p>There are certain HTML Elements that cannot have internal <code>&lt;div id="string"&gt;...&lt;/div&gt;</code>.</p>
<p>For example:</p> <p>For example:</p>
<pre><code> # &lt;div id=&quot;string&quot;&gt;THIS WILL NOT WORK!&lt;/div&gt; &lt;=== this will not work</code></pre> <pre><code> # &lt;div id=&quot;string&quot;&gt;THIS WILL NOT WORK!&lt;/div&gt; &lt;!-- this will not work --&gt;</code></pre>
<p>For things like headings, you have to surround them as in:</p> <p>For things like headings, you have to surround them, as in:</p>
<pre><code> &lt;div id=&quot;string&quot;&gt; <pre><code> &lt;div id=&quot;string&quot;&gt;
# This will work # This will work
&lt;/div&gt;</code></pre> &lt;/div&gt;</code></pre>
<p>While some browsers will still recognize the HTML construct <code>&lt;a name="string"&gt;...&lt;/a&gt;</code>, it is possible they might NOT in the future.</p> <p>While some browsers will still recognize the HTML construct <code>&lt;a name="string"&gt;...&lt;/a&gt;</code>, it is possible they might NOT in the future.</p>
<h2 id="please-do-not-use-the-strike-nor-s-html-element">Please do NOT use the <code>&lt;strike&gt;</code> nor <code>&lt;s&gt;</code> HTML element</h2> <h2 id="please-do-not-use-the-strike-or-s-html-element">Please do NOT use the <code>&lt;strike&gt;</code> or <code>&lt;s&gt;</code> HTML element</h2>
<p>Please NOT use the obsolete <code>&lt;strike&gt;</code> nor <code>&lt;s&gt;</code> (<del> <em>strikeout</em> </del>) HTML elements:</p> <p>Please NOT use the obsolete <code>&lt;strike&gt;</code> or <code>&lt;s&gt;</code> (<del><em>strikeout</em></del>) HTML elements:</p>
<pre><code> &lt;strike&gt;...&lt;/strike&gt; &lt;=== no thank you <pre><code> &lt;strike&gt;...&lt;/strike&gt; &lt;!-- no thank you --&gt;
&lt;s&gt;...&lt;/s&gt; &lt;=== no thank you</code></pre> &lt;s&gt;...&lt;/s&gt; &lt;!-- no thank you --&gt;</code></pre>
<p>Use instead:</p> <p>Use instead:</p>
<pre><code> &lt;del&gt;...&lt;/del&gt;</code></pre> <pre><code> &lt;del&gt;...&lt;/del&gt;</code></pre>
<h2 id="please-do-not-use-the-u-html-element">Please do NOT use the <code>&lt;u&gt;</code> HTML element</h2> <h2 id="please-do-not-use-the-u-html-element">Please do NOT use the <code>&lt;u&gt;</code> HTML element</h2>
<p>Please NOT use the obsolete <code>&lt;u&gt;</code> (<ins><em>underline</em></ins>) HTML element:</p> <p>Please NOT use the obsolete <code>&lt;u&gt;</code> (<ins><em>underline</em></ins>) HTML element:</p>
<pre><code> &lt;u&gt;...&lt;/u&gt; &lt;=== no thank you</code></pre> <pre><code> &lt;u&gt;...&lt;/u&gt; &lt;!-- no thank you --&gt;</code></pre>
<p>Use instead:</p> <p>Use instead:</p>
<pre><code> &lt;ins&gt;...&lt;/ins&gt;</code></pre> <pre><code> &lt;ins&gt;...&lt;/ins&gt;</code></pre>
<h2 id="please-do-not-use-the-tt-html-element">Please do NOT use the <code>&lt;tt&gt;</code> HTML element</h2> <h2 id="please-do-not-use-the-tt-html-element">Please do NOT use the <code>&lt;tt&gt;</code> HTML element</h2>
<p>Please do <strong>NOT</strong> use the obsolete <code>&lt;tt&gt;</code> (<span style="font-family: monospace;"><em>teletype</em></span>) HTML element:</p> <p>Please do <strong>NOT</strong> use the obsolete <code>&lt;tt&gt;</code> (<span style="font-family: monospace;"><em>teletype</em></span>) HTML element:</p>
<pre><code> &lt;tt&gt;The obsolete tt element is obsolete&lt;/tt&gt; &lt;=== no thank you</code></pre> <pre><code> &lt;tt&gt;The obsolete tt element is obsolete&lt;/tt&gt; &lt;!-- no thank you --&gt;</code></pre>
<p>Instead use either a monospaced span:</p> <p>Instead use either a monospaced span:</p>
<pre><code> &lt;span style=&quot;font-family: monospace;&quot;&gt;Use of monospaced font is one option&lt;/span&gt;</code></pre> <pre><code> &lt;span style=&quot;font-family: monospace;&quot;&gt;Use of monospaced font is one option&lt;/span&gt;</code></pre>
<p>Or better and easier still, use an inline markdown code block:</p> <p>Or better and easier still, use an inline markdown code block:</p>
@@ -436,8 +436,7 @@ for the given page URL.</p>
<h2 id="please-do-not-use-unindented-code-blocks">Please do NOT use unindented code blocks</h2> <h2 id="please-do-not-use-unindented-code-blocks">Please do NOT use unindented code blocks</h2>
<p>Please do <strong>NOT</strong> start code blocks at the left-hand edge.</p> <p>Please do <strong>NOT</strong> start code blocks at the left-hand edge.</p>
<pre><code>``` <pre><code>```
This code block &lt;=== no thank you This code block is NOT indented &lt;!-- no thank you --&gt;
is NOT indented
```</code></pre> ```</code></pre>
<p>We request that you indent the code block by 4 spaces:</p> <p>We request that you indent the code block by 4 spaces:</p>
<pre><code>``` <pre><code>```
markdown.md
+15 -16
View File
@@ -1,21 +1,21 @@
# IOCCC markdown best practices # IOCCC markdown best practices
The IOCCC makes extensive use of [markdown](https://daringfireball.net/projects/markdown/). The IOCCC makes extensive use of [markdown](https://daringfireball.net/projects/markdown/).
For example, we [submitting to the IOCCC](faq.html#submit), we have people For example, when [submitting to the IOCCC](faq.html#submit), we have people
to submit remarks about entry in markdown format. Every submit remarks about their entry in markdown format. Every
[winning IOCCC entry](years.html) uses a `README.md` markdown file [winning IOCCC entry](years.html) uses a `README.md` markdown file
as the basis for forming the `index.html` web page for that entry. as the basis for forming the `index.html` web page for that entry.
All generated HTML pages on the [Official IOCCC website](https://www.ioccc.org/index.html) All generated HTML pages on the [Official IOCCC website](https://www.ioccc.org/index.html)
start with some markdown content. start with some markdown content.
See the [markdown syntax](https://www.markdownguide.org/basic-syntax) guide. See the [markdown syntax](https://www.markdownguide.org/basic-syntax) guide.
See also [CommonMark Spec](https://spec.commonmark.org/current/). See also the [CommonMark Spec](https://spec.commonmark.org/current/).
Nevertheless, the IOCCC does have certain practices that we ask authors to follow. Nevertheless, the IOCCC does have certain practices that we ask authors to follow.
Some these relate to use of markdown directly, others relate to injecting HTML Some of these relate to use of markdown directly and others relate to injecting HTML
into the markdown file. into the markdown file.
In particular there are things we ask people to please do **NOT** use in In particular there are things we ask people to please **NOT** use in
markdown files for the IOCCC: markdown files for the IOCCC:
@@ -24,7 +24,7 @@ markdown files for the IOCCC:
Please do **NOT** use the HTML construct: Please do **NOT** use the HTML construct:
``` ```
<a name="string">...</a> <=== no thank you <a name="string">...</a> <!-- no thank you -->
``` ```
as those are **NOT** part of the HTML 5 standard. as those are **NOT** part of the HTML 5 standard.
@@ -46,10 +46,10 @@ id="string">...</div>`.
For example: For example:
``` ```
# <div id="string">THIS WILL NOT WORK!</div> <=== this will not work # <div id="string">THIS WILL NOT WORK!</div> <!-- this will not work -->
``` ```
For things like headings, you have to surround them as in: For things like headings, you have to surround them, as in:
``` ```
<div id="string"> <div id="string">
@@ -61,13 +61,13 @@ While some browsers will still recognize the HTML construct `<a
name="string">...</a>`, it is possible they might NOT in the future. name="string">...</a>`, it is possible they might NOT in the future.
## Please do NOT use the `<strike>` nor `<s>` HTML element ## Please do NOT use the `<strike>` or `<s>` HTML element
Please NOT use the obsolete `<strike>` nor `<s>` (<del> _strikeout_ </del>) HTML elements: Please NOT use the obsolete `<strike>` or `<s>` (<del>_strikeout_</del>) HTML elements:
``` ```
<strike>...</strike> <=== no thank you <strike>...</strike> <!-- no thank you -->
<s>...</s> <=== no thank you <s>...</s> <!-- no thank you -->
``` ```
Use instead: Use instead:
@@ -82,7 +82,7 @@ Use instead:
Please NOT use the obsolete `<u>` (<ins>_underline_</ins>) HTML element: Please NOT use the obsolete `<u>` (<ins>_underline_</ins>) HTML element:
``` ```
<u>...</u> <=== no thank you <u>...</u> <!-- no thank you -->
``` ```
Use instead: Use instead:
@@ -97,7 +97,7 @@ Use instead:
Please do **NOT** use the obsolete `<tt>` (<span style="font-family: monospace;">_teletype_</span>) HTML element: Please do **NOT** use the obsolete `<tt>` (<span style="font-family: monospace;">_teletype_</span>) HTML element:
``` ```
<tt>The obsolete tt element is obsolete</tt> <=== no thank you <tt>The obsolete tt element is obsolete</tt> <!-- no thank you -->
``` ```
Instead use either a monospaced span: Instead use either a monospaced span:
@@ -119,8 +119,7 @@ Please do **NOT** start code blocks at the left-hand edge.
```` ````
``` ```
This code block <=== no thank you This code block is NOT indented <!-- no thank you -->
is NOT indented
``` ```
```` ````
news.html
+4 -4
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./bugs.html" class="sub-item-link"> <a href="./bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./next/index.html" class="sub-item-link"> <a href="./next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./bugs.html"> <a class="mobile-submenu-item" href="./bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./next/index.html"> <a class="mobile-submenu-item" href="./next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="./news.html"> <a class="mobile-submenu-item" href="./news.html">
next/guidelines.html
+4 -4
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="../bugs.html" class="sub-item-link"> <a href="../bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="../next/index.html" class="sub-item-link"> <a href="../next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="../bugs.html"> <a class="mobile-submenu-item" href="../bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="../next/index.html"> <a class="mobile-submenu-item" href="../next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="../news.html"> <a class="mobile-submenu-item" href="../news.html">
next/index.html
+4 -4
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="../bugs.html" class="sub-item-link"> <a href="../bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="../next/index.html" class="sub-item-link"> <a href="../next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="../bugs.html"> <a class="mobile-submenu-item" href="../bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="../next/index.html"> <a class="mobile-submenu-item" href="../next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="../news.html"> <a class="mobile-submenu-item" href="../news.html">
next/rules.html
+4 -4
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="../bugs.html" class="sub-item-link"> <a href="../bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="../next/index.html" class="sub-item-link"> <a href="../next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="../bugs.html"> <a class="mobile-submenu-item" href="../bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="../next/index.html"> <a class="mobile-submenu-item" href="../next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="../news.html"> <a class="mobile-submenu-item" href="../news.html">
nojs-menu.html
+7 -7
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./bugs.html" class="sub-item-link"> <a href="./bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./next/index.html" class="sub-item-link"> <a href="./next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./bugs.html"> <a class="mobile-submenu-item" href="./bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./next/index.html"> <a class="mobile-submenu-item" href="./next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="./news.html"> <a class="mobile-submenu-item" href="./news.html">
@@ -388,18 +388,18 @@
<li><a href="years.html">Winning Entries</a></li> <li><a href="years.html">Winning Entries</a></li>
<li><a href="authors.html">People who have won</a></li> <li><a href="authors.html">People who have won</a></li>
<li><a href="location.html">Location of authors</a></li> <li><a href="location.html">Location of authors</a></li>
<li><a href="bugs.html">Bugs &amp; Misfeatures</a></li> <li><a href="bugs.html">Bugs and (mis)features</a></li>
</ul> </ul>
<h2 id="status">Status</h2> <h2 id="status">Status</h2>
<ul> <ul>
<li><a href="news.html">IOCCC News</a></li> <li><a href="news.html">IOCCC News</a></li>
<li><a href="status.html">Contest status</a></li> <li><a href="status.html">Contest status</a></li>
<li><a href="next/index.html">Rules &amp; Guidelines</a></li> <li><a href="next/index.html">Rules and Guidelines</a></li>
</ul> </ul>
<h2 id="faq">FAQ</h2> <h2 id="faq">FAQ</h2>
<ul> <ul>
<li><a href="faq.html">FAQ</a></li> <li><a href="faq.html">FAQ</a></li>
<li><a href="faq.html#fix_an_entry">How to enter the IOCCC</a></li> <li><a href="faq.html#submit">How to enter the IOCCC</a></li>
<li><a href="faq.html#fix_an_entry">Fixing IOCCC entries</a></li> <li><a href="faq.html#fix_an_entry">Fixing IOCCC entries</a></li>
<li><a href="faq.html#fix_web_site">Fixing the website</a></li> <li><a href="faq.html#fix_web_site">Fixing the website</a></li>
<li><a href="faq.html#fix_author">Fixing author info</a></li> <li><a href="faq.html#fix_author">Fixing author info</a></li>
nojs-menu.md
+3 -3
View File
@@ -5,18 +5,18 @@
* [Winning Entries](years.html) * [Winning Entries](years.html)
* [People who have won](authors.html) * [People who have won](authors.html)
* [Location of authors](location.html) * [Location of authors](location.html)
* [Bugs &amp; Misfeatures](bugs.html) * [Bugs and (mis)features](bugs.html)
## Status ## Status
* [IOCCC News](news.html) * [IOCCC News](news.html)
* [Contest status](status.html) * [Contest status](status.html)
* [Rules &amp; Guidelines](next/index.html) * [Rules and Guidelines](next/index.html)
## FAQ ## FAQ
* [FAQ](faq.html) * [FAQ](faq.html)
* [How to enter the IOCCC](faq.html#fix_an_entry) * [How to enter the IOCCC](faq.html#submit)
* [Fixing IOCCC entries](faq.html#fix_an_entry) * [Fixing IOCCC entries](faq.html#fix_an_entry)
* [Fixing the website](faq.html#fix_web_site) * [Fixing the website](faq.html#fix_web_site)
* [Fixing author info](faq.html#fix_author) * [Fixing author info](faq.html#fix_author)
status.html
+4 -4
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./bugs.html" class="sub-item-link"> <a href="./bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./next/index.html" class="sub-item-link"> <a href="./next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./bugs.html"> <a class="mobile-submenu-item" href="./bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./next/index.html"> <a class="mobile-submenu-item" href="./next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="./news.html"> <a class="mobile-submenu-item" href="./news.html">
thanks-for-help.html
+4 -4
View File
@@ -80,7 +80,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./bugs.html" class="sub-item-link"> <a href="./bugs.html" class="sub-item-link">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
</div> </div>
@@ -106,7 +106,7 @@
<div class="outfit-font"> <div class="outfit-font">
<a href="./next/index.html" class="sub-item-link"> <a href="./next/index.html" class="sub-item-link">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
</div> </div>
</div> </div>
@@ -236,7 +236,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./bugs.html"> <a class="mobile-submenu-item" href="./bugs.html">
Bugs &amp; (Mis)features Bugs and (mis)features
</a> </a>
</div> </div>
@@ -254,7 +254,7 @@
</a> </a>
<a class="mobile-submenu-item" href="./next/index.html"> <a class="mobile-submenu-item" href="./next/index.html">
Rules &amp; Guidelines Rules and Guidelines
</a> </a>
<a class="mobile-submenu-item" href="./news.html"> <a class="mobile-submenu-item" href="./news.html">