From b19846fb4dd01d368010785604e93985c4fefc36 Mon Sep 17 00:00:00 2001 From: Landon Curt Noll Date: Fri, 28 Nov 2025 08:47:33 -0800 Subject: [PATCH] improve markdown Fixed a number of whitespace, HTML comments, intending, and markdown problems. Clarified the syntax. Made a number of textual changes to be more consistent. Replaced emoji with HTML symbols. Misc cleanup. Ran `make markdown sitemap` to perform the above. --- markdown.html | 332 +++++++++++++++++++---------------- markdown.md | 466 +++++++++++++++++++++++++++++--------------------- sitemap.xml | 4 +- 3 files changed, 454 insertions(+), 348 deletions(-) diff --git a/markdown.html b/markdown.html index e19b81fc1..95c572b55 100644 --- a/markdown.html +++ b/markdown.html @@ -454,10 +454,7 @@

IOCCC 29th Markdown Guidelines

Markdown Guidelines Version

-

These Markdown Guidelines are version 29.0 2025-11-26.

-
- -
+

These Markdown Guidelines are version 29.01 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 @@ -467,7 +464,8 @@ that entry. All HTML 5 generated pages on the markdown syntax guide. See also the CommonMark Spec. +

See the markdown syntax guide. +See also the CommonMark Spec. See the FAQ on “remarks.md submission file”.

Nevertheless, the IOCCC does have certain practices that we ask authors to follow. Some of these relate to use of markdown directly and others relate @@ -481,31 +479,31 @@ and ✔️ for preferred correct one.

If (it is not required) you do use sections in your remarks.md file (this does not apply to other markdown files), PLEASE start at level three up to level six:

❌ Reserved in remarks.md only.

-
# Section Reserved
-## Section Reserved
-

✔ Available every where.

-
### Section Level 3
-#### Section Level 4
-##### Section Level 5
-###### Section Level 6
+
    # Section Reserved
+    ## Section Reserved
+

✅ Available every where.

+
    ### Section Level 3
+    #### Section Level 4
+    ##### Section Level 5
+    ###### Section Level 6
-

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

+

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

❌ Incorrect.

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

✔ Correct.

-
<div id="new_way"></div>
+
    <a name="old_way">Section title</a>

+
✅ Correct.

+
    <div id="new_way"></div>
 
-### Section title

+    ### Section title

❌ Incorrect.

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

✔ Correct.

-
[markdown link text](#link_target)
+
    This <a href="#link_target>HTML link text</a> works, but we prefer see below...
+

✅ Correct.

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

Replace <strike> or <s>

❌ Incorrect.

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

✔ Correct.

-
~~markdown striked through text~~
-<del>HTML 5 striked through text</del>
+
    <strike>striked through text</strike>
+    <s>HTML 5 striked through text</s>
+

✅ Correct.

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

Replace <u>

❌ Incorrect.

-
<u>old tags</u>
-

✔ Correct.

-
<ins>HTML 5 tags</ins>
+
    <u>old tags</u>
+

✅ Correct.

+
    <ins>HTML 5 tags</ins>

Replace <tt>

❌ Incorrect.

-
<tt>obsolete HTML</tt>
-

✔ Correct.

-
<span style="font-family: monospace;">monospace font</span>
-`markdown style monospace`
+
    <tt>obsolete HTML</tt>
+

✅ Correct.

+
    <span style="font-family: monospace;">monospace font</span>
+    `markdown style monospace`
-

Indent code blocks by four spaces, not by TAB.

+

Indent code blocks by four spaces, not by TAB

❌ Incorrect.

-
echo "This code block is NOT indented"
+
 ``` <!---sh-->
+echo "This shell code block is NOT properly indented!"
+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.

-
    echo "This code block is indented by multiples of 4 spaces"
+
✅ 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.

+
    ``` <!---sh-->
+        echo "This shell code block is indented by multiples of 4 spaces"
 
-    # The top level starts with a 4 ASCII space indent.
-    #
-    # Only indent with multiples of 4 ASCII spaces.
-        # 2nd level indent needs 8 ASCII spaces (no tabs).
-            # 3rd level indent needs 12 ASCII spaces (no tabs).
-                # etc.

-
Alternatively its possible to use ``` marks, without the initial
-four (4) space indentation. This is usually the better method.

-
✔ Also correct.

-
```
-The same thing applies to any markdown block bracketed by ``` lines.
-```

+        for i in $(seq 1 9); do
+            echo "This 2nd level is intented by 8 spaces (no tabs)"
+            if [[ $i -gt 5 ]]; then
+                echo "This 3rd level is intented by 12 spaces (no tabs)"
+                break
+            fi
+        done
+    ```
+

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.

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

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

+

✅ OK for C.

+
    ``` <!---c-->
+    /* not intending C code is OK */
+    int
+    bar(int foo)
+    {
+       return foo;
+    }
+    ```
-

Do not use TAB in markdown files.

+

Do not use TAB in markdown files

Please do NOT indent with ASCII TABs (␉), OR use any ASCII TAB (␉) anywhere inside a markdown file.

While we have nothing against the ASCII TAB (␉) character in general, @@ -577,77 +596,88 @@ used as part of the leading whitespace within a markdown file.

If you need to indent two (2) or more levels, use multiples of four (4) ASCII SPACES.

❌ Incorrect for markdown files only.

-
```
-␉Please do **NOT**␉use ASCII tabs␉in markdown files.
-␉␉Please do **NOT** indent markdown with ASCII tabs.
+
    ```
+    ␉Please do **NOT**␉use ASCII tabs␉in markdown files.
+    ␉␉Please do **NOT** indent markdown with ASCII tabs.
 
-␉We␉don't␉mind␉tabs␉in␉general,
-␉We just ask that you NOT use them in markdown files.
-```

-
✔ Ok for all file types, eg. .c, .h, .mk, .sh, EXCEPT .md markdown files.

-
␉printf("It is fine␉to␉use tabs in Obfuscated C code.\n");
-␉␉/*␉if␉you␉wish    */
+    ␉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.

+
    ␉printf("It is fine␉to␉use tabs in Obfuscated C code.\n");
+    ␉␉/*␉if␉you␉wish    */
 
-␉// 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.

+    ␉// 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.
+

NOTE: For purposes of visual illustration, ASCII TABs are shown above with the ␉ symbol.

-

Use HTML comments for code block language syntax.

+

Use HTML comments for code block language syntax

We request that fenced markdown code blocks NOT specify a language directly.

-

❌ Incorrect

-
```c
-    int main(void) {return 0;}
-```
+

❌ Incorrect.

+
    ```c
+        int main(void) {return 0;}
+    ```

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

-

✔ Correct

-
```<!---c-->
-   int main(void) {return 0;}
-```
+

✅ Correct.

+
    ``` <!---c-->
+        int main(void) {return 0;}
+    ```
+

PLEASE NOTE: There is an IMPORTANT ASCII SPACE between the 3 backticks (```) +and the start of the HTML comment!

+

PLEASE: Use an HTML comment that is of this form:

+
-

Ensure blank line between code block and text.

-

❌ Incorrect, missing empty line after closing fence (```).

-
```
-int
-main(int foo)
-{
-   return foo;
-}
-```
-C compilers cannot be given a -Wno-main-arg-errors flag.
-

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

-
```
-int
-main(int foo)
-{
-    return foo;
-}
-```
+
Ensure blank line between code block and text

+
❌ Incorrect, missing empty line after closing 3 backtick (```) fence.

+
    ``` <!---c-->
+    /* The C compiler will insist in flagging this an error, unfortunately */
+    int
+    main(int foo)
+    {
+       return foo;
+    }
+    ```
+    C compilers cannot be given a -Wno-main-arg-errors flag.

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

+
    ``` <!---c-->
+    /* The C compiler will insist in flagging this an error, unfortunately */
+    int
+    main(int foo)
+    {
+        return foo;
+    }
+    ```
 
-C compilers cannot be given a -Wno-main-arg-errors flag.

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

Do not add trailing slash to void HTML tags.

+

Do not add trailing slash to void HTML tags

The trailing slash on void HTML elements has no effect and interacts badly with unquoted attribute values; do not use. See also this note on trailing slashes in void-element start tags.

-

❌ Incorrect

-
<br/>
-<hr/>
-<img src="1984-anonymous-tattoo.jpg" alt="image of a tattoo of
-the 1984 anonymous C code" width=600 height=401 />
-

✔ Correct

-
<br>
-<hr>
-<img src="1984-anonymous-tattoo.jpg" alt="image of a tattoo of
-the 1984 anonymous C code" width=600 height=401>
+

❌ Incorrect.

+
    <br/>
+    <hr/>
+    <img src="1984-anonymous-tattoo.jpg" alt="image of a tattoo of
+    the 1984 anonymous C code" width=600 height=401 />
+

✅ Correct.

+
    <br>
+    <hr>
+    <img src="1984-anonymous-tattoo.jpg" alt="image of a tattoo of
+    the 1984 anonymous C code" width=600 height=401>
@@ -656,38 +686,38 @@ the 1984 anonymous C code" width=600 height=401>

Do not use a trailing backslash outside of a code block

❌ Incorrect, do not use escaped newlines outside of a code block.

-
In markdown,\
-do NOT use trailing\
-backslashes outside of\
-a code block
-

✔ Correct

-
In markdown,<br>
-use trailing<br>
-br's outside of<br>
-a code block
+
    In markdown,\
+    do NOT use trailing\
+    backslashes outside of\
+    a code block

+
✅ Correct.

+
    In markdown,<br>
+    use trailing<br>
+    br's outside of<br>
+    a code block
 
-```
-This is OK\
-inside a\
-markdown code\
-block
-```
+    ```
+    This is OK\
+    inside a\
+    markdown code\
+    block
+    ```
 
-`This is OK\`

+    `This is OK\`

Doing it this way will prevent pandoc(1) from generating deprecated HTML elements, such as <br />.

Do not use markdown style images

-

❌ Incorrect

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

✔ Correct

-
<img src="filename.png"
-alt="describe the filename.png image for someone who cannot view it"
-width=PIXEL_WIDTH height=PIXEL_HEIGHT>
+
❌ Incorrect.

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

+
✅ Correct.

+
    <img src="filename.png"
+    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=`.

+    Which allows for HTML <img> attributes `alt=`, `width=` and `length=`.

The problem is that pandoc(1) generates problematic HTML from the markdown image construct, the resulting HTML does NOT have width and height information so browsers have to slow down on rendering @@ -695,7 +725,7 @@ text around the image until it can internally determine the image size.

-

Replace markdown style horizontal lines.

+

Replace markdown style horizontal lines

Please do NOT use --- style lines in markdown to create horizontal lines or to separate sections.

Unless something is inside a markdown code block, do NOT start @@ -703,38 +733,38 @@ a line with 3 or more dashes (“-”s).

Such markdown causes pandoc(1) to generate <hr />. The <hr /> has no effect in standard HTML 5 and interacts badly with unquoted attribute values.

-

❌ Incorrect

-
* * *
-- - -
----
-

✔ Correct

-
Regular divider...
-<hr>
+
❌ Incorrect.

+
    * * *
+    - - -
+    ---

+
✅ Correct.

+
    Regular divider...
+    <hr>
 
-A short divider...
-<hr style="width:10%;text-align:left;margin-left:0">

+    A short divider...
+    <hr style="width:10%;text-align:left;margin-left:0">
-

❌ Incorrect

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

✔ Correct

-
[some &lpar;text&rpar;](https://example.com/curds)
-[ls&lpar;1&rpar;](https://example.com/ls-man-page.1)
+

❌ Incorrect.

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

✅ Correct.

+
    [some &lpar;text&rpar;](https://example.com/curds)
+    [ls&lpar;1&rpar;](https://example.com/ls-man-page.1)

Markdown links that end in “))” complicate parsing and sometimes lead to incorrect URLs or file paths.

-

❌ Incorrect

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

✔ Correct

-
[some text](https://example.com/foo_&lpar;bar&rpar;)
-This thing, [some text](some/path), is better.
+

❌ Incorrect.

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

✅ Correct.

+
    [some text](https://example.com/foo_&lpar;bar&rpar;)
+    This thing, [some text](some/path), is better.
@@ -743,13 +773,13 @@ This thing, [some text](some/path), is better. Instead use an underscore (_). Using an asterisk can complicate parsing and sometimes lead to incorrect results. This can especially go for when it is bold and italic.

-

❌ Incorrect

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

✔ Correct

-
_this text is italic_
-**_this text is bold italic_**
-_**this text is bold italic**_
+

❌ Incorrect.

+
    *this text is italic*
+    ***this text is bold italic***
+

✅ Correct.

+
    _this text is italic_
+    **_this text is bold italic_**
+    _**this text is bold italic**_

BTW: the astute reader might notice that some cases of * for italic might have slipped through. We do ask you, however, to please observe this rule, as best you can. diff --git a/markdown.md b/markdown.md index ea1bd103b..3d7c0ad66 100644 --- a/markdown.md +++ b/markdown.md @@ -1,11 +1,10 @@ - # IOCCC 29th Markdown Guidelines + ## Markdown Guidelines Version -These [Markdown Guidelines](markdown.html) are version **29.0 2025-11-26**. +These [Markdown Guidelines](markdown.html) are version **29.01 2025-11-28**. -

## Introduction @@ -18,150 +17,196 @@ start with some markdown content. We no longer support older HTML standards and some of our guidelines help integrate winning entries into the website more easily. -See the [markdown syntax](https://www.markdownguide.org/basic-syntax) guide. See also the [CommonMark Spec](https://spec.commonmark.org/current/). +See the [markdown syntax](https://www.markdownguide.org/basic-syntax) guide. +See also the [CommonMark Spec](https://spec.commonmark.org/current/). See the FAQ on "[remarks.md submission file](faq.html#remarks_md)". Nevertheless, the IOCCC does have certain practices that we ask authors to 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 +In the sections below, examples will mark by ❌ for the incorrect method and ✔️ for preferred correct one. +
+ ## Start `remarks.md` sections at level 3 If (it is not required) you do use sections in your `remarks.md` file (this does not apply to other markdown files), **PLEASE** start at level three up to level six: -❌ Reserved in `remarks.md` only. -``` -# Section Reserved -## Section Reserved +❌ Reserved in `remarks.md` only. +``` + # Section Reserved + ## Section Reserved ``` -✔ Available every where. +✅ Available every where. ``` -### Section Level 3 -#### Section Level 4 -##### Section Level 5 -###### Section Level 6 + ### Section Level 3 + #### Section Level 4 + ##### Section Level 5 + ###### Section Level 6 ``` +
-## Replace `` construct. -❌ Incorrect. -``` -Section title +## Replace `` construct + +❌ Incorrect. +``` + Section title ``` -✔ Correct. -``` -
+✅ Correct. +``` +
-### Section title + ### Section title ``` + ## Markdown links instead of `...` -❌ Incorrect. -``` -This ❌ Incorrect. +``` + This ✔ Correct. -``` -[markdown link text](#link_target) +✅ Correct. +``` + [markdown link text](#link_target) ``` +
+ ## Replace `` or `` -❌ Incorrect. -``` -striked through text -HTML 5 striked through text +❌ Incorrect. +``` + striked through text + HTML 5 striked through text ``` -✔ Correct. -``` -~~markdown striked through text~~ -HTML 5 striked through text +✅ Correct. +``` + ~~markdown striked through text~~ + HTML 5 striked through text ``` +
+ ## Replace `` -❌ Incorrect. -``` -old tags +❌ Incorrect. +``` + old tags ``` -✔ Correct. -``` -HTML 5 tags +✅ Correct. +``` + HTML 5 tags ``` +
+ ## Replace `` -❌ Incorrect. -``` -obsolete HTML +❌ Incorrect. +``` + obsolete HTML ``` -✔ Correct. -``` -monospace font -`markdown style monospace` +✅ Correct. +``` + monospace font + `markdown style monospace` ``` +
-## Indent code blocks by four spaces, not by TAB. -❌ Incorrect. -``` -echo "This code block is NOT indented" +## Indent code blocks by four spaces, not by TAB + +❌ Incorrect. +```` + ``` +echo "This shell code block is NOT properly indented!" +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. -```` - echo "This code block is indented by multiples of 4 spaces" - - # The top level starts with a 4 ASCII space indent. - # - # Only indent with multiples of 4 ASCII spaces. - # 2nd level indent needs 8 ASCII spaces (no tabs). - # 3rd level indent needs 12 ASCII spaces (no tabs). - # etc. +✅ Correct. +```` + ``` + echo "This shell code block is indented by multiples of 4 spaces" + ``` ```` -Alternatively its possible to use ` ``` ` marks, without the initial -four (4) space indentation. This is usually the better method. +If you need to intent more than one level, use multiples of 4 ASCII spaces (no tabs): -✔ Also correct. -```` -``` -The same thing applies to any markdown block bracketed by ``` lines. -``` +✅ Also Correct. +```` + ``` + echo "This shell code block is indented by multiples of 4 spaces" + + for i in $(seq 1 9); do + echo "This 2nd level is intented by 8 spaces (no tabs)" + if [[ $i -gt 5 ]]; then + echo "This 3rd level is intented by 12 spaces (no tabs)" + break + fi + done + ``` ```` +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. +```` + ``` + Intent text by multiples of 4 spaces if possible. + ``` +```` + +A reasonable exception to the rule is when are displaying C: + +✅ OK for C. + +```` + ``` + /* not intending C code is OK */ + int + bar(int foo) + { + return foo; + } + ``` +```` + +
-## Do not use TAB in markdown files. + +## Do not use TAB in markdown files Please do **NOT** indent with ASCII TABs (␉), **OR** use any ASCII TAB (␉) anywhere inside a markdown file. @@ -173,152 +218,174 @@ used as part of the leading whitespace within a markdown file. If you need to indent two (2) or more levels, use multiples of four (4) ASCII SPACES. -❌ Incorrect for markdown files only. -```` -``` -␉Please do **NOT**␉use ASCII tabs␉in markdown files. -␉␉Please do **NOT** indent markdown with ASCII tabs. +❌ Incorrect for markdown files only. +```` + ``` + ␉Please do **NOT**␉use ASCII tabs␉in markdown files. + ␉␉Please do **NOT** indent markdown with ASCII tabs. -␉We␉don't␉mind␉tabs␉in␉general, -␉We just ask that you NOT use them in markdown files. -``` + ␉We␉don't␉mind␉tabs␉in␉general, + ␉We just ask that you NOT use them in markdown files. + ``` ```` -✔ Ok for all file types, eg. `.c`, `.h`, `.mk`, `.sh`, **EXCEPT** `.md` markdown files. -```` -␉printf("It is fine␉to␉use tabs in Obfuscated C code.\n"); -␉␉/*␉if␉you␉wish */ +✅ 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 */ -␉// 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. + ␉// 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. ```` +**NOTE**: For purposes of visual illustration, ASCII TABs are shown above with the `␉` symbol. + +
-## Use HTML comments for code block language syntax. + +## Use HTML comments for code block language syntax We request that [fenced markdown code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) **NOT** specify a language directly. -❌ Incorrect -```` -```c - int main(void) {return 0;} -``` +❌ Incorrect. +```` + ```c + int main(void) {return 0;} + ``` ```` Instead, put the language inside an HTML comment, separated from the markdown code block starting fence by a space: -✔ Correct -```` -``` - int main(void) {return 0;} -``` +✅ Correct. +```` + ``` + int main(void) {return 0;} + ``` ```` +**PLEASE NOTE**: There is an **IMPORTANT** ASCII SPACE between the 3 backticks (```) +and the start of the HTML comment! + +**PLEASE**: Use an HTML comment that is of this form: + + * starts with `` (note the 2 dashes) + +
-## Ensure blank line between code block and text. -❌ Incorrect, missing empty line after closing fence (` ``` `). -```` -``` -int -main(int foo) -{ - return foo; -} -``` -C compilers cannot be given a -Wno-main-arg-errors flag. +## Ensure blank line between code block and text + +❌ Incorrect, missing empty line after closing 3 backtick (```) fence. +```` + ``` + /* The C compiler will insist in flagging this an error, unfortunately */ + int + main(int foo) + { + return foo; + } + ``` + C compilers cannot be given a -Wno-main-arg-errors flag. ```` -✔ Correct, has empty line between closing fence and subsequent text. -```` -``` -int -main(int foo) -{ - return foo; -} -``` +✅ Correct, has empty line between closing fence and subsequent text. +```` + ``` + /* The C compiler will insist in flagging this an error, unfortunately */ + int + main(int foo) + { + return foo; + } + ``` -C compilers cannot be given a -Wno-main-arg-errors flag. + C compilers cannot be given a -Wno-main-arg-errors flag. ```` +
-## Do not add trailing slash to void HTML tags. +## Do not add trailing slash to void HTML tags The trailing slash on [void HTML elements](https://github.com/validator/validator/wiki/Markup-»-Void-elements) has no effect and interacts badly with unquoted attribute values; do not use. See also this note on [trailing slashes in void-element start tags](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). -❌ Incorrect -``` -
-
-image of a tattoo of -the 1984 anonymous C code +❌ Incorrect. +``` +
+
+ image of a tattoo of + the 1984 anonymous C code ``` -✔ Correct -``` -
-
-image of a tattoo of -the 1984 anonymous C code +✅ Correct. +``` +
+
+ image of a tattoo of + the 1984 anonymous C code ``` +
+ ## Do not use a trailing backslash outside of a code block -❌ Incorrect, do not use escaped newlines outside of a code block. -``` -In markdown,\ -do NOT use trailing\ -backslashes outside of\ -a code block +❌ Incorrect, do not use escaped newlines outside of a code block. +``` + In markdown,\ + do NOT use trailing\ + backslashes outside of\ + a code block ``` -✔ Correct -```` -In markdown,
-use trailing
-br's outside of
-a code block +✅ Correct. +```` + In markdown,
+ use trailing
+ br's outside of
+ a code block -``` -This is OK\ -inside a\ -markdown code\ -block -``` + ``` + This is OK\ + inside a\ + markdown code\ + block + ``` -`This is OK\` + `This is OK\` ```` Doing it this way will prevent `pandoc(1)` from generating deprecated HTML elements, such as `
`. +
+ ## Do not use markdown style images -❌ Incorrect -``` -![alt text](filename.png "Title") +❌ Incorrect. +``` + ![alt text](filename.png "Title") ``` -✔ Correct -``` - +✅ Correct. +``` + describe the filename.png image for someone who cannot view it -Which allows for HTML attributes `alt=`, `width=` and `length=`. + Which allows for HTML attributes `alt=`, `width=` and `length=`. ``` The problem is that `pandoc(1)` generates problematic HTML from the @@ -326,9 +393,11 @@ markdown image construct, the resulting HTML does **NOT** have `width` and `height` information so browsers have to slow down on rendering text around the image until it can internally determine the image size. +
-## Replace markdown style horizontal lines. + +## Replace markdown style horizontal lines Please do **NOT** use `---` style lines in markdown to create horizontal lines or to separate sections. @@ -340,59 +409,65 @@ Such markdown causes `pandoc(1)` to generate `
`. The `
` has no effect in standard HTML 5 and interacts badly with unquoted attribute values. -❌ Incorrect -``` -* * * -- - - ---- +❌ Incorrect. +``` + * * * + - - - + --- ``` -✔ Correct -``` -Regular divider... -
+✅ Correct. +``` + Regular divider... +
-A short divider... -
+ A short divider... +
``` +
+ ## Do not put a literal "`(`" or "`)`" in markdown link titles -❌ Incorrect -``` -[some (text)](https://example.com/curds) -[ls(1)](https://example.com/ls-man-page.1) +❌ Incorrect. +``` + [some (text)](https://example.com/curds) + [ls(1)](https://example.com/ls-man-page.1) ``` -✔ Correct -``` -[some (text)](https://example.com/curds) -[ls(1)](https://example.com/ls-man-page.1) +✅ Correct. +``` + [some (text)](https://example.com/curds) + [ls(1)](https://example.com/ls-man-page.1) ``` +
+ ## Do not end markdown links with "`))`" Markdown links that end in "`))`" complicate parsing and sometimes lead to incorrect URLs or file paths. -❌ Incorrect -``` -[some text](https://example.com/foo_(bar)) -This thing, ([some text](some/path)), is NOT ideal. +❌ Incorrect. +``` + [some text](https://example.com/foo_(bar)) + This thing, ([some text](some/path)), is NOT ideal. ``` -✔ Correct -``` -[some text](https://example.com/foo_(bar)) -This thing, [some text](some/path), is better. +✅ Correct. +``` + [some text](https://example.com/foo_(bar)) + This thing, [some text](some/path), is better. ``` +
+ ## Use `_` for italics in markdown Please do **NOT** use `*` (single asterisk) for italics in markdown. @@ -400,18 +475,19 @@ Instead use an underscore (`_`). Using an asterisk can complicate parsing and sometimes lead to incorrect results. This can especially go for when it is **_bold and italic_**. -❌ Incorrect -``` -*this text is italic* -***this text is bold italic*** +❌ Incorrect. +``` + *this text is italic* + ***this text is bold italic*** ``` -✔ Correct -``` -_this text is italic_ -**_this text is bold italic_** -_**this text is bold italic**_ +✅ Correct. +``` + _this text is italic_ + **_this text is bold italic_** + _**this text is bold italic**_ ``` + **BTW**: the astute reader might notice that some cases of `*` for italic might have slipped through. We do ask you, however, to please observe this rule, as best you can. diff --git a/sitemap.xml b/sitemap.xml index 770827a54..39fb72b72 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -16810,11 +16810,11 @@ https://www.ioccc.org/markdown.html - 2025-11-28T05:02:34+00:00 + 2025-11-28T16:46:49+00:00 https://www.ioccc.org/markdown.md - 2025-11-28T04:59:17+00:00 + 2025-11-28T16:46:44+00:00 https://www.ioccc.org/news.html