diff --git a/markdown.html b/markdown.html index 95c572b55..3b583eff3 100644 --- a/markdown.html +++ b/markdown.html @@ -454,7 +454,7 @@

IOCCC 29th Markdown Guidelines

Markdown Guidelines Version

-

These Markdown Guidelines are version 29.01 2025-11-28.

+

These Markdown Guidelines are version 29.02 2025-11-28.

Introduction

The IOCCC makes extensive use of markdown. For example, when submitting to the IOCCC we have people submit remarks about their @@ -471,7 +471,7 @@ See the FAQ on “remarks.md submission file follow. Some of these relate to use of markdown directly and others relate to injecting HTML into the markdown file.

In the sections below, examples will mark by ❌ for the incorrect method -and ✔️ for preferred correct one.

+and ✔ for preferred correct one.

@@ -481,7 +481,7 @@ not apply to other markdown files), PLEASE start at level three

❌ Reserved in remarks.md only.

    # Section Reserved
     ## Section Reserved
-

✅ Available every where.

+

✔ Available every where.

    ### Section Level 3
     #### Section Level 4
     ##### Section Level 5
@@ -492,7 +492,7 @@ not apply to other markdown files), PLEASE start at level three
 

Replace <a name="anchor_name"></a> construct

❌ Incorrect.

    <a name="old_way">Section title</a>
-

✅ Correct.

+

✔ Correct.

    <div id="new_way"></div>
 
     ### Section title
@@ -502,7 +502,7 @@ not apply to other markdown files), PLEASE start at level three

❌ Incorrect.

    This <a href="#link_target>HTML link text</a> works, but we prefer see below...
-

✅ Correct.

+

✔ Correct.

    [markdown link text](#link_target)
@@ -514,7 +514,7 @@ not apply to other markdown files), PLEASE start at level three

❌ Incorrect.

    <strike>striked through text</strike>
     <s>HTML 5 striked through text</s>
-

✅ Correct.

+

✔ Correct.

    ~~markdown striked through text~~
     <del>HTML 5 striked through text</del>
@@ -526,7 +526,7 @@ not apply to other markdown files), PLEASE start at level three

Replace <u>

❌ Incorrect.

    <u>old tags</u>
-

✅ Correct.

+

✔ Correct.

    <ins>HTML 5 tags</ins>
@@ -534,7 +534,7 @@ not apply to other markdown files), PLEASE start at level three

Replace <tt>

❌ Incorrect.

    <tt>obsolete HTML</tt>
-

✅ Correct.

+

✔ Correct.

    <span style="font-family: monospace;">monospace font</span>
     `markdown style monospace`
@@ -548,12 +548,12 @@ 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) ASCII SPACES, never TAB (␉):

-

✅ Correct.

+

✔ Correct.

    ``` <!---sh-->
         echo "This shell code block is indented by multiples of 4 spaces"
     ```

If you need to intent more than one level, use multiples of 4 ASCII spaces (no tabs):

-

✅ Also Correct.

+

✔ Also Correct.

    ``` <!---sh-->
         echo "This shell code block is indented by multiples of 4 spaces"
 
@@ -567,12 +567,12 @@ ASCII SPACES, never TAB (␉):

```

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:

-

✅ Preferred.

+

✔ Preferred.

    ```
         Intent text by multiples of 4 spaces if possible.
     ```

A reasonable exception to the rule is when are displaying C:

-

✅ OK for C.

+

✔ OK for C.

    ``` <!---c-->
     /* not intending C code is OK */
     int
@@ -603,7 +603,7 @@ ASCII SPACES.

␉We␉don't␉mind␉tabs␉in␉general, ␉We just ask that you NOT use them in markdown files. ```
-

✅ OK for all file types, e.g., .c, .h, .mk, .sh, EXCEPT .md markdown files.

+

✔ OK for all file types, e.g., .c, .h, .mk, .sh, EXCEPT .md markdown files.

    ␉printf("It is fine␉to␉use tabs in Obfuscated C code.\n");
     ␉␉/*␉if␉you␉wish    */
 
@@ -624,7 +624,7 @@ ASCII SPACES.

```

Instead, put the language inside an HTML comment, separated from the markdown code block starting fence by a space:

-

✅ Correct.

+

✔ Correct.

    ``` <!---c-->
         int main(void) {return 0;}
     ```
@@ -650,7 +650,7 @@ and the start of the HTML comment!

} ``` C compilers cannot be given a -Wno-main-arg-errors flag. -

✅ Correct, has empty line between closing fence and subsequent text.

+

✔ Correct, has empty line between closing fence and subsequent text.

    ``` <!---c-->
     /* The C compiler will insist in flagging this an error, unfortunately */
     int
@@ -673,7 +673,7 @@ on ✅ Correct.

+

✔ Correct.

    <br>
     <hr>
     <img src="1984-anonymous-tattoo.jpg" alt="image of a tattoo of
@@ -690,7 +690,7 @@ on ✅ Correct.

+

✔ Correct.

    In markdown,<br>
     use trailing<br>
     br's outside of<br>
@@ -712,7 +712,7 @@ HTML elements, such as <br />.

Do not use markdown style images

❌ Incorrect.

    ![alt text](filename.png "Title")
-

✅ Correct.

+

✔ Correct.

    <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.

    * * *
     - - -
     ---
-

✅ Correct.

+

✔ Correct.

    Regular divider...
     <hr>
 
@@ -750,7 +750,7 @@ values.

❌ Incorrect.

    [some (text)](https://example.com/curds)
     [ls(1)](https://example.com/ls-man-page.1)
-

✅ Correct.

+

✔ Correct.

    [some &lpar;text&rpar;](https://example.com/curds)
     [ls&lpar;1&rpar;](https://example.com/ls-man-page.1)
@@ -762,7 +762,7 @@ to incorrect URLs or file paths.

❌ Incorrect.

    [some text](https://example.com/foo_(bar))
     This thing, ([some text](some/path)), is NOT ideal.
-

✅ Correct.

+

✔ Correct.

    [some text](https://example.com/foo_&lpar;bar&rpar;)
     This thing, [some text](some/path), is better.
@@ -776,7 +776,7 @@ go for when it is bold and italic.

❌ Incorrect.

    *this text is italic*
     ***this text is bold italic***
-

✅ Correct.

+

✔ Correct.

    _this text is italic_
     **_this text is bold italic_**
     _**this text is bold italic**_
diff --git a/markdown.md b/markdown.md index 3d7c0ad66..e870bf167 100644 --- a/markdown.md +++ b/markdown.md @@ -3,7 +3,7 @@ ## 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 @@ -26,7 +26,7 @@ follow. Some of these relate to use of markdown directly and others relate to injecting HTML into the markdown file. In the sections below, examples will mark by ❌ for the incorrect method -and ✔️ for preferred correct one. +and ✔ for preferred correct one.
@@ -43,7 +43,7 @@ not apply to other markdown files), **PLEASE** start at level three up to level ## Section Reserved ``` -✅ Available every where. +✔ Available every where. ``` ### Section Level 3 #### Section Level 4 @@ -62,7 +62,7 @@ not apply to other markdown files), **PLEASE** start at level three up to level
Section title ``` -✅ Correct. +✔ Correct. ```
@@ -80,7 +80,7 @@ not apply to other markdown files), **PLEASE** start at level three up to level This ✅ Correct. +✔ Correct. ``` [markdown link text](#link_target) ``` @@ -97,7 +97,7 @@ not apply to other markdown files), **PLEASE** start at level three up to level HTML 5 striked through text ``` -✅ Correct. +✔ Correct. ``` ~~markdown striked through text~~ HTML 5 striked through text @@ -114,7 +114,7 @@ not apply to other markdown files), **PLEASE** start at level three up to level old tags ``` -✅ Correct. +✔ Correct. ``` HTML 5 tags ``` @@ -130,7 +130,7 @@ not apply to other markdown files), **PLEASE** start at level three up to level obsolete HTML ``` -✅ Correct. +✔ Correct. ``` monospace font `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) ASCII SPACES, never TAB (␉): -✅ Correct. +✔ Correct. ```` ``` 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): -✅ Also Correct. +✔ Also Correct. ```` ``` 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 four (4) space indentation, we **prefer** that you multiples of 4 spaces if possible: -✅ Preferred. +✔ Preferred. ```` ``` 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: -✅ OK for C. +✔ OK for C. ```` ``` @@ -229,7 +229,7 @@ ASCII SPACES. ``` ```` -✅ OK for all file types, e.g., `.c`, `.h`, `.mk`, `.sh`, **EXCEPT** `.md` markdown files. +✔ OK for all file types, e.g., `.c`, `.h`, `.mk`, `.sh`, **EXCEPT** `.md` markdown files. ```` ␉printf("It is fine␉to␉use tabs in Obfuscated C code.\n"); ␉␉/*␉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 markdown code block starting fence by a space: -✅ Correct. +✔ Correct. ```` ``` 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. ```` -✅ Correct, has empty line between closing fence and subsequent text. +✔ Correct, has empty line between closing fence and subsequent text. ```` ``` /* 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 /> ``` -✅ Correct. +✔ Correct. ```

@@ -348,7 +348,7 @@ on [trailing slashes in void-element start tags](https://github.com/validator/va a code block ``` -✅ Correct. +✔ Correct. ```` In markdown,
use trailing
@@ -379,7 +379,7 @@ HTML elements, such as `
`. ![alt text](filename.png "Title") ``` -✅ Correct. +✔ Correct. ``` describe the filename.png image for someone who cannot view it✅ Correct. +✔ Correct. ``` Regular divider...
@@ -437,7 +437,7 @@ values. [ls(1)](https://example.com/ls-man-page.1) ``` -✅ Correct. +✔ Correct. ``` [some (text)](https://example.com/curds) [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. ``` -✅ Correct. +✔ Correct. ``` [some text](https://example.com/foo_(bar)) 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*** ``` -✅ Correct. +✔ Correct. ``` _this text is italic_ **_this text is bold italic_** diff --git a/sitemap.xml b/sitemap.xml index 39fb72b72..5bcb30d33 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -16810,11 +16810,11 @@ https://www.ioccc.org/markdown.html - 2025-11-28T16:46:49+00:00 + 2025-11-29T04:28:46+00:00 https://www.ioccc.org/markdown.md - 2025-11-28T16:46:44+00:00 + 2025-11-29T04:30:44+00:00 https://www.ioccc.org/news.html @@ -16826,11 +16826,11 @@ https://www.ioccc.org/next/guidelines.html - 2025-11-28T04:58:56+00:00 + 2025-11-29T04:32:18+00:00 https://www.ioccc.org/next/guidelines.md - 2025-11-28T04:58:56+00:00 + 2025-11-29T04:32:18+00:00 https://www.ioccc.org/next/index.html @@ -16870,11 +16870,11 @@ https://www.ioccc.org/next/rules.html - 2025-11-28T04:58:56+00:00 + 2025-11-29T04:32:18+00:00 https://www.ioccc.org/next/rules.md - 2025-11-28T04:58:56+00:00 + 2025-11-29T04:32:18+00:00 https://www.ioccc.org/next/submit.html