# IOCCC 29th Markdown Guidelines ## Markdown Guidelines Version These [Markdown Guidelines](markdown.html) are version **29.02 2025-11-28**. ## Introduction The IOCCC makes extensive use of [markdown](https://daringfireball.net/projects/markdown/). For example, when submitting to the IOCCC we have people submit remarks about their entry in markdown format. Every [winning entry](years.html) uses a `README.md` markdown file as the basis for forming the `index.html` web page for that entry. All HTML 5 generated pages on the [Official IOCCC website](https://www.ioccc.org/index.html) 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 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 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 ``` ✔ Available every where. ``` ### Section Level 3 #### Section Level 4 ##### Section Level 5 ###### Section Level 6 ```

## Replace `` construct ❌ Incorrect. ``` Section title ``` ✔ Correct. ```

### Section title ```

## Markdown links instead of `...` ❌ Incorrect. ``` This ✔ Correct. ``` [markdown link text](#link_target) ```

## Replace `` or `` ❌ Incorrect. ``` ~~striked through text~~ ~~HTML 5 striked through text~~ ``` ✔ Correct. ``` ~~markdown striked through text~~ ~~HTML 5 striked through text~~ ```
## Replace `` ❌ Incorrect. ``` old tags ``` ✔ Correct. ``` HTML 5 tags ```
## Replace `` ❌ Incorrect. ``` obsolete HTML ``` ✔ Correct. ``` monospace font `markdown style monospace` ``` ## 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 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. ```` ``` 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 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, we have discovered that ASCII TAB (␉) characters create problems when 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. ␉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. ```` **NOTE**: For purposes of visual illustration, ASCII TABs are shown above with the `␉` symbol. ## 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;} ``` ```` 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;} ``` ```` **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 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. ```` ``` /* 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. ```` ## 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. ``` ``` ✔ Correct. ``` ``` ## 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, use trailing br's outside of a code block ``` This is OK\ inside a\ markdown code\ block ``` `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") ``` ✔ Correct. ``` Which allows for HTML 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 text around the image until it can internally determine the image size. ## 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 a line with 3 or more dashes ("`-`"s). Such markdown causes `pandoc(1)` to generate ` `. The `` has no effect in standard HTML 5 and interacts badly with unquoted attribute values. ❌ Incorrect. ``` * * * - - - --- ``` ✔ Correct. ``` Regular 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) ``` ✔ 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. ``` ✔ 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. 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**_ ``` **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.