From 2aa9faa4b6eb821eb8993c698e8110e35446aee0 Mon Sep 17 00:00:00 2001 From: Anthony Howe Date: Fri, 21 Nov 2025 19:27:25 -0500 Subject: [PATCH 1/3] Refactor markdown guidelines to improve space and presentation. --- markdown.md | 807 +++++++++++++++------------------------------------- 1 file changed, 225 insertions(+), 582 deletions(-) diff --git a/markdown.md b/markdown.md index 9fb7045705..f9be73751c 100644 --- a/markdown.md +++ b/markdown.md @@ -1,717 +1,360 @@ -
-# IOCCC 28th Markdown Guidelines -
+
+# IOCCC 29th Markdown Guidelines -
-## IOCCC Markdown guidelines version -
+
+## Markdown Guidelines Version -

-These [IOCCC markdown guidelines](markdown.html) are version **28.4 2025-04-28**. -

+These [Markdown Guidelines](markdown.html) are version **28.4 2025-04-28**. -**IMPORTANT**: Be sure to read the [IOCCC rules](next/rules.html) and [IOCCC -guidelines](next/guidelines.html). +
+## Markdown Guidelines 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. -Jump to: [top](#) +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)". -
-## IOCCC Markdown Guidelines Introduction -
+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. -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 IOCCC entry](years.html) uses a `README.md` markdown file -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) -start with some markdown content. +In the sections below, examples will mark by ✕ for the incorrect method and ✔ for preferred correct one. -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. +
+## Start `remarks.md` sections at level 3 -Jump to: [top](#) +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 upto level six: -
-## Please DO start `remarks.md` sections at level 3 (`###`), increasing for subsections up to 6 (`######`) -
- -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: - -``` - # Foo <=== no thank you - ## Foo <=== no thank you -``` - -Instead, start sections with 3 `#`s: - - -``` - ### Section 0 -``` - -For each subsection of the current section, add another `#`, up to 6, going back -to 3 for new sections. For instance: - - -``` - ### Section 0 - ... - #### 1st subsection of section 0 - ... - ##### 1st sub-subsection of the 1st subsection of section 0 - ... - #### 2nd subsection of section 0 - ... - ##### 1st sub-subsection of the 2nd subsection of section 0 - ... - ##### 2nd sub-subsection of the 2nd subsection of section 0 - ... - ###### 1st sub-sub-subsection of the 2nd sub-subsection of the 2nd subsection of section 0 - ... - ### Section 1 - ... - ### Section 2 - ... - Etc. -``` - - -
-
-## Please do NOT use the `name` attributes in HTML `...` hyperlink elements -
-
- -Please do **NOT** use the HTML construct: - -``` - ... <=== no thank you -``` - -as those are **NOT** part of the HTML 5 standard. - -Instead use: - -``` -
...
-``` - -where the `...` is the HTML you want to "name". The `
` -encapsulates the HTML you want to name: i.e., the target of some -`` or some other `` -for the given page URL. - -### IMPORTANT POINT: - -There are certain markdown constructs that **CANNOT** have an **internal** `
...
` element. - -An example is headings (lines that start with a `#`). For example: - - -``` - #
THIS WILL NOT WORK!
<=== this will not work +``` +✕ # Section Reserved +✕ ## Section Reserved +✔ ### Section Level 3 +✔ #### Section Level 4 +✔ ##### Section Level 5 +✔ ###### Section Level 6 ``` -For things like headings, you have to surround them with the `
...
` element, as in: +
+
+## Replace `` construct. -``` -
- # This will work -
+``` +✕ ... +✔
...
``` -While some browsers will still recognize the HTML construct `...`, it is possible **they MIGHT NOT** in the future. - -Jump to: [top](#) - - - -It is easier and preferred to use markdown links rather than HTML `..` -anchors. - -Instead of: - + +## Markdown links instead of `...` -``` - Use of HTML link text works, but we prefer +✔ [markdown link text](#link_target) ``` +
+
+## Replace `` or `` -``` - [markdown links](#links) are easier and preferred -``` - -Jump to: [top](#) - -
-
-## Please do NOT use the `` or the `` HTML element -
-
+``` +✕ striked through text +✕ HTML 5 striked through text -Please do **NOT** use the obsolete `` or the obsolete `` -(**strikeout**) HTML elements: - -``` - ... <=== no thank you - ... <=== no thank you +✔ HTML 5 striked through text +✔ ~~markdown striked through text~~ ``` -Use instead: +
+
+## Replace `` -``` - ... +``` +✕ old tags +✔ HTML 5 tags ``` -Jump to: [top](#) - -
-
-## Please do NOT use the `` HTML element -
-
+
+
+## Replace `` -Please do **NOT** use the obsolete `` (_underline_) HTML element: - -``` - ... <=== no thank you +``` +✕ obsolete HTML +✔ monospace font +✔ `markdown style monospace` ``` -Use instead: +
+
+## Always indent code blocks 4 spaces, not tab. -``` - ... +``` +✕ echo "This code block is NOT indented" ``` -Jump to: [top](#) - -
-
-## Please do NOT use the `` HTML element -
-
+We request that you indent the code block by multiples of four (4) ASCII SPACES, never TAB (␉): -Please do **NOT** use the obsolete `` -(**teletype**) HTML element: - -``` - The tt element is obsolete <=== no thank you -``` +```` +✔ echo "This code block is indented by mutiples of 4 spaces" -Instead use either a monospaced `` or an inline markdown code block: - -``` - Use of a monospaced font - is one option, - however ... -``` - -We recommend using the inline markdown code block method instead: - -``` - Using the `inline markdown code block` is easier and is **preferred**. -``` - -Jump to: [top](#) - -
-
-## Please do NOT use unindented code blocks -
-
- -Please do **NOT** start code blocks at the first column. - -For example: - -```` -``` <%%NO_COMMENT%%!---sh--> -echo "This code block is NOT indented" <=== no thank you -``` +✔ # 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. ```` -We request that you indent the code block by multiples of 4 ASCII **SPACES**: - -```` -``` <%%NO_COMMENT%%!---sh--> - echo "This code block is indented by mutiples of 4 spaces" +Alternatively its possible to use ` ``` ` marks, without the initial four (4) space indentation. This is usually the better method. - # 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. -``` +```` +✔ ``` +✔ The same thing applies to any markdown block bracketed by ``` lines. +✔ ``` ```` -Moreover: - -```` -``` - The same thing applies to any markdown block surrounded by ``` lines. -``` -```` - -Please do **NOT** indent using ASCII tab characters in markdown files. - -Jump to: [top](#) +
+
+## Do not use ASCII TAB in markdown files. -
-
-## Please do NOT use ASCII tabs in markdown files -
-
+Please do **NOT** indent with ASCII TABs (␉), **OR** use any ASCII TAB (␉) anywhere inside a markdown file. -Please do **NOT** indent with ASCII tabs, **OR** use any -ASCII tab characters 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. -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. -If you need to indent 2 or more levels, use multiples of 4 ASCII -**SPACES**. - -For example: - -```` +```` ``` - Please do **NOT** use ASCII tabs in markdown files. <=== no thank you - Please do **NOT** indent markdown with ASCII tabs. <=== no thank you +✕ ␉Please do **NOT**␉use ASCII tabs␉in markdown files. +✕ ␉␉Please do **NOT** indent markdown with ASCII tabs. - We don't mind tabs in general, <=== no thank you - 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. ``` ```` -And to clarify, we are only talking about markdown files, -not C code or any other non-markdown content: +And to clarify, we are only talking about markdown files, not C code or any other non-markdown content: -```` - printf("It is fine to use tabs in Obfuscated C code.\n"); - /* if you wish */ +```` +✔ 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**: Again, you are **perfectly welcome** to use ASCII tab characters in -your C code and other non-markdown files. We simply ask that you do **NOT** use any -ASCII tab characters in markdown files. - -Jump to: [top](#) +**NOTE**: Again, you are **perfectly welcome** to use ASCII tab characters in your C code and other non-markdown files. We simply ask that you do **NOT** use any ASCII TAB (␉) characters in markdown files. -
+
### Tip for `vim` users -
-If you use `vim` you can put in your `.vimrc` file (usually `~/.vimrc`) the -following settings to make sure the tabs are not put in without you noticing: +If you use `vim` you can put in your `.vimrc` file (usually `~/.vimrc`) the following settings to make sure the tabs are not put in without you noticing: -``` - set tabstop=8 " a tab is 8 spaces (or whatever you wish it to be set to) - set softtabstop=4 " ...but when inserting/backspacing use 4 spaces - set shiftwidth=4 " ...and auto-indent 4 spaces (when autoindent is set) - set expandtab " ...expand tab into spaces +``` +set tabstop=8 " a tab is 8 spaces (or whatever you wish it to be set to) +set softtabstop=4 " ...but when inserting/backspacing use 4 spaces +set shiftwidth=4 " ...and auto-indent 4 spaces (when autoindent is set) +set expandtab " ...expand tab into spaces ``` -If you have file type detection enabled you can, if you prefer, have these -settings set just for markdown files: +If you have file type detection enabled you can, if you prefer, have these settings set just for markdown files: -``` - autocmd! Filetype markdown setlocal set tabstop=8 softtabstop=4 shiftwidth=4 expandtab +``` +autocmd! Filetype markdown setlocal set tabstop=8 softtabstop=4 shiftwidth=4 expandtab ``` -or so. - -This will prevent the tab key from inserting tabs; rather it will insert 4 -spaces. +This will prevent the tab key from inserting tabs; rather it will insert four (4) spaces. To **VERIFY** that there are no tabs in a file you may do, in command mode: ``` - /\t +/\t ``` If you're in insert mode hit `ESC` first. -Jump to: [top](#) - -
-
-## Please use HTML comments to specify a language for a code block -
-
+
+
+## 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. +We request that [fenced markdown code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) **NOT** specify a language directly. -For example: - -```` -```c <=== no thank you +```` +```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: +Instead, put the language inside an HTML comment, separated from the markdown code block starting fence by a space: -```` -``` <%%NO_COMMENT%%!---c--> +```` +``` int main(void) {return 0;} ``` ```` -**IMPORTANT**: The **initial**   **\` \` \`**   must be followed by an **ASCII SPACE**, -and **THEN** an **opening** **``" (two "`-`"s -followed by a "`>`"). - - -Jump to: [top](#) - -
-
-## Please do NOT add trailing slash to void HTML elements -
-
- -Please do **NOT** use a trailing slash on [void HTML -elements](https://github.com/validator/validator/wiki/Markup-»-Void-elements). - -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). - -The trailing slash on void HTML elements has no effect and interacts badly with -unquoted attribute values. - -For example, please do **NOT** use markdown like these: - -``` -
<=== no thank you +**IMPORTANT**: The **initial**   **\` \` \`**   must be followed by an **ASCII SPACE**, and **THEN** an **opening** **``" (two "`-`"s followed by a "`>`"). + +
+
+
+## Insure blank line between code block and text. + +Please do **NOT** place text on the next line after a markdown code block. Instead, place a blank line after the end of a markdown code block as this makes it easier to detect when markdown code blocks are **NOT** properly indented. + +```` +✕ ``` +✕ int +✕ main(int foo) +✕ { +✕ return foo; +✕ } +✕ ``` +✕ C compilers cannot be given a -Wno-main-arg-errors flag. + +✔ ``` +✔ int +✔ main(int foo) +✔ { +✔ return foo; +✔ } +✔ ``` +✔ +✔ C compilers cannot be given a -Wno-main-arg-errors flag. +```` -
<=== no thank you +
+
+## Do not add trailing slash to void HTML tags. - image of a tattoo of the 1984 anonymous C code <=== no thank you -``` +Please do **NOT** use a trailing slash on [void HTML elements](https://github.com/validator/validator/wiki/Markup-»-Void-elements). -Instead use, respectively: +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). -``` -
+The trailing slash on void HTML elements has no effect and interacts badly with unquoted attribute values. -
+``` +✕
+✕
+✕ image of a tattoo of the 1984 anonymous C code - image of a tattoo of the 1984 anonymous C code +✔
+✔
+✔ image of a tattoo of the 1984 anonymous C code ``` -Jump to: [top](#) - -
-
-## Please do NOT use a TRAILING backslash (`\`) outside of a code block -
-
- -Unless the line is inside a markdown code block, please do **NOT** -end a markdown line with a trailing backslash (`\`). Instead use -a trailing `
`. +
+
+## Do not use a trailing backslash (`\`) outside of a code block -Instead of: +Unless the line is inside a markdown code block, please do **NOT** end a markdown line with a trailing backslash (`\`). Instead use a trailing `
`. -``` - In markdown,\ <=== no thank you - do NOT use trailing\ - backslashes outside of\ - a code block -``` - -use: +``` +✕ In markdown,\ +✕ do NOT use trailing\ +✕ backslashes outside of\ +✕ a code block -``` - In markdown,
- use trailing
- br's outside of
- a code block -``` +✔ In markdown,
+✔ use trailing
+✔ br's outside of
+✔ a code block -Again, use of a trailing backslash (`\`) inside a markdown code block is fine: +✔ ``` +✔ This is OK\ +✔ inside a\ +✔ markdown code\ +✔ block +✔ ``` -```` -``` - This is OK\ - inside a\ - markdown code\ - block -``` +✔ `This is OK\` ```` -as is: - -``` - `This is OK\` -``` - -Doing it this way will prevent `pandoc(1)` from generating deprecated HTML -elements such as `
`. - -Jump to: [top](#) - -
-
-## Please do NOT use markdown style images -
-
+Doing it this way will prevent `pandoc(1)` from generating deprecated HTML elements such as `
`. -Please do **NOT** use the markdown embedded image element. +
+
+## Do not use markdown style images Instead of using this markdown element to embed an image: -``` - ![alt text](filename.png "Title") <=== no thank you -``` +``` +✕ ![alt text](filename.png "Title") -Use an `` HTML element with `alt=`, `width=` and `length=` -attributes: +✔ describe the filename.png image for someone who cannot view it -``` - describe the filename.png image for someone who cannot view it + Which allows for HTML attributes `alt=`, `width=` and `length=`. ``` -For example, instead of: - -``` - ![1984-anonymous-tattoo.jpg](1984-anonymous-tattoo.jpg) <=== no thank you -``` +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. -use this HTML: - -``` - image of a tattoo of the 1984 anonymous C code -``` - -The problem goes beyond the fact 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. - -Jump to: [top](#) - -
-
-
+
+
+
## Please do NOT use markdown style horizontal lines -
-
-
-Please do **NOT** use `---` style lines in markdown to create horizontal -lines or to separate sections. +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). +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. +Such markdown causes `pandoc(1)` to generate `
`. The `
` has no effect in standard HTML 5 and interacts badly with unquoted attribute values. If a horizontal line is really needed, use: -``` -
-``` - -If a short line is needed, use: - -``` -
-``` - - -Jump to: [top](#) +``` +✕ * * * +✕ - - - +✕ --- -
-## Please do NOT put a LITERAL "`(`" or "`)`" in markdown link titles -
+ Regular divider... +✔
-Please do **NOT** use literal parentheses inside markdown link titles. - -Instead of: - -``` - [some (text)](https://example.com/curds) <=== no thank you + A short divider... +✔
``` -use: +
+## Do not put a literal "`(`" or "`)`" in markdown link titles -``` - [some (text)](https://example.com/curds) -``` +``` +✕ [some (text)](https://example.com/curds) +✔ [some (text)](https://example.com/curds) -Instead of: - -``` - [ls(1)](https://example.com/ls-man-page.1) <=== no thank you +✕ [ls(1)](https://example.com/ls-man-page.1) +✔ [ls(1)](https://example.com/ls-man-page.1) ``` -use: +
+## Do not end markdown links with "`))`" -``` - [ls(1)](https://example.com/ls-man-page.1) -``` +Markdown links that end in "`))`" complicate parsing and sometimes lead to incorrect URLs or file paths. -Jump to: [top](#) +``` +✕ [some text](https://example.com/foo_(bar)) +✔ [some text](https://example.com/foo_(bar)) -
-## Please do NOT end markdown links with "`))`" -
- -Please do **NOT** end a markdown link with a double closed parenthesis "`))`". - -Markdown links that end in "`))`" complicate parsing and sometimes lead -to incorrect URLs or file paths. - -Instead of: - -``` - [some text](https://example.com/foo_(bar)) <=== no thank you +✕ This thing, ([some text](some/path)), is NOT ideal. +✔ This thing, [some text](some/path), is better. ``` -use: - -``` - [some text](https://example.com/foo_(bar)) -``` - - - -As another example, instead of: - -``` - This thing, ([some text](some/path)), is NOT ideal. <=== no thank you -``` - -use: - -``` - This thing, [some text](some/path), is better. -``` - -Jump to: [top](#) - -
-
-
-## Please do NOT place text on the IMMEDIATE (very next) line after a markdown code block -
-
-
- -Please do **NOT** place text on the next line after a markdown code block. -Instead, place a blank line after the end of a markdown code block -as this makes it easier to detect when markdown code blocks are -**NOT** properly indented. - -Instead of: - -```` -``` - int - main(int foo) - { - return foo; - } -``` -C compilers cannot be given a -Wno-main-arg-errors flag. <=== no thank you -```` - -use: - -```` -``` - int - main(int foo) - { - return foo; - } -``` - -C compilers cannot be given a -Wno-main-arg-errors flag. -```` - -**BTW**: Please note the blank line after the code block. - -Jump to: [top](#) - -
-## Please use `_` for italics in markdown -
+
+## 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_**. -For example, instead of: - -``` - *this text is italic* <=== no thank you -``` - -use: - -``` - _this text is italic_ -``` - -Another example, for **_bold italic_**: +``` +✕ *this text is italic* +✔ _this text is italic_ -Do **NOT** use: - - -``` - ***this text is bold italic*** <=== no thank you -``` - -Instead use: - -``` - **_this text is bold italic_** +✕ ***this text is bold italic*** +✔ **_this text is bold italic_** +✔ _**this text is bold italic**_ ``` - -or: - -``` - _**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. From 2846b12a4a01fc27805b8f06b3d0b6a398208dd3 Mon Sep 17 00:00:00 2001 From: Anthony Howe Date: Sat, 22 Nov 2025 09:11:07 -0500 Subject: [PATCH 2/3] Reformat lines as with line breaks; fix some spelling. --- markdown.md | 140 +++++++++++++++++++++++++++++++++++----------------- 1 file changed, 95 insertions(+), 45 deletions(-) diff --git a/markdown.md b/markdown.md index f9be73751c..251b213c93 100644 --- a/markdown.md +++ b/markdown.md @@ -9,19 +9,33 @@ These [Markdown Guidelines](markdown.html) are version **28.4 2025-04-28**.
## Markdown Guidelines 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. +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)". +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. +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. +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 upto level six: +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: ``` ✕ # Section Reserved @@ -88,10 +102,11 @@ IF (it is not required) you do use sections in your `remarks.md` file (this does ✕ echo "This code block is NOT indented" ``` -We request that you indent the code block by multiples of four (4) ASCII SPACES, never TAB (␉): +We request that you indent the code block by multiples of four (4) +ASCII SPACES, never TAB (␉): ```` -✔ echo "This code block is indented by mutiples of 4 spaces" +✔ echo "This code block is indented by multiples of 4 spaces" ✔ # The top level starts with a 4 ASCII space indent. ✔ # @@ -101,7 +116,8 @@ We request that you indent the code block by multiples of four (4) ASCII SPACES, ✔ # etc. ```` -Alternatively its possible to use ` ``` ` marks, without the initial four (4) space indentation. This is usually the better method. +Alternatively its possible to use ` ``` ` marks, without the initial +four (4) space indentation. This is usually the better method. ```` ✔ ``` @@ -113,11 +129,15 @@ Alternatively its possible to use ` ``` ` marks, without the initial four (4) sp
## Do not use ASCII TAB in markdown files. -Please do **NOT** indent with ASCII TABs (␉), **OR** use any ASCII TAB (␉) anywhere inside a markdown file. +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. +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. +If you need to indent two (2 or more levels, use multiples of four (4) +ASCII SPACES. ```` ``` @@ -129,7 +149,8 @@ If you need to indent two (2 or more levels, use multiples of four (4) ASCII SPA ``` ```` -And to clarify, we are only talking about markdown files, not C code or any other non-markdown content: +And to clarify, we are only talking about markdown files, not C code or +any other non-markdown content: ```` ✔ printf("It is fine to use tabs in Obfuscated C code.\n"); @@ -139,12 +160,16 @@ And to clarify, we are only talking about markdown files, not C code or any othe ✔ // or in any other markdown files within your entry, please. ```` -**NOTE**: Again, you are **perfectly welcome** to use ASCII tab characters in your C code and other non-markdown files. We simply ask that you do **NOT** use any ASCII TAB (␉) characters in markdown files. +**NOTE**: Again, you are **perfectly welcome** to use ASCII tab +characters in your C code and other non-markdown files. We simply ask +that you do **NOT** use any ASCII TAB (␉) characters in markdown files.
### Tip for `vim` users -If you use `vim` you can put in your `.vimrc` file (usually `~/.vimrc`) the following settings to make sure the tabs are not put in without you noticing: +If you use `vim` you can put in your `.vimrc` file (usually `~/.vimrc`) +the following settings to make sure the tabs are not put in without you +noticing: ``` set tabstop=8 " a tab is 8 spaces (or whatever you wish it to be set to) @@ -153,15 +178,18 @@ set shiftwidth=4 " ...and auto-indent 4 spaces (when autoindent is se set expandtab " ...expand tab into spaces ``` -If you have file type detection enabled you can, if you prefer, have these settings set just for markdown files: +If you have file type detection enabled you can, if you prefer, have +these settings set just for markdown files: ``` autocmd! Filetype markdown setlocal set tabstop=8 softtabstop=4 shiftwidth=4 expandtab ``` -This will prevent the tab key from inserting tabs; rather it will insert four (4) spaces. +This will prevent the tab key from inserting tabs; rather it will insert +four (4) spaces. -To **VERIFY** that there are no tabs in a file you may do, in command mode: +To **VERIFY** that there are no tabs in a file you may do, in command +mode: ``` /\t @@ -173,30 +201,39 @@ If you're in insert mode hit `ESC` first.
## 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. +We request that [fenced markdown code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) +**NOT** specify a language directly. ```` -```c - int main(void) {return 0;} -``` +✕ ```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: +Instead, put the language inside an HTML comment, separated from the +markdown code block starting fence by a space: ```` -``` - int main(void) {return 0;} -``` +✔ ``` +✔ int main(void) {return 0;} +✔ ``` ```` -**IMPORTANT**: The **initial**   **\` \` \`**   must be followed by an **ASCII SPACE**, and **THEN** an **opening** **``" (two "`-`"s followed by a "`>`"). +**IMPORTANT**: The **initial**   **\` \` \`**   must be +followed by an **ASCII SPACE**, and **THEN** an **opening** ** +``" (two "`-`"s +followed by a "`>`").
-## Insure blank line between code block and text. +## Ensure blank line between code block and text. -Please do **NOT** place text on the next line after a markdown code block. Instead, place a blank line after the end of a markdown code block as this makes it easier to detect when markdown code blocks are **NOT** properly indented. +Please do **NOT** place text on the next line after a markdown code +block. Instead, place a blank line after the end of a markdown code +block as this makes it easier to detect when markdown code blocks are +**NOT** properly indented. ```` ✕ ``` @@ -223,11 +260,13 @@ Please do **NOT** place text on the next line after a markdown code block. Inste
## Do not add trailing slash to void HTML tags. -Please do **NOT** use a trailing slash on [void HTML elements](https://github.com/validator/validator/wiki/Markup-»-Void-elements). +Please do **NOT** use a trailing slash on +[void HTML elements](https://github.com/validator/validator/wiki/Markup-»-Void-elements). 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). -The trailing slash on void HTML elements has no effect and interacts badly with unquoted attribute values. +The trailing slash on void HTML elements has no effect and interacts +badly with unquoted attribute values. ``` ✕
@@ -247,7 +286,9 @@ The trailing slash on void HTML elements has no effect and interacts badly with
## Do not use a trailing backslash (`\`) outside of a code block -Unless the line is inside a markdown code block, please do **NOT** end a markdown line with a trailing backslash (`\`). Instead use a trailing `
`. +Unless the line is inside a markdown code block, please do **NOT** end +a markdown line with a trailing backslash (`\`). Instead use a trailing +`
`. ``` ✕ In markdown,\ @@ -270,7 +311,8 @@ Unless the line is inside a markdown code block, please do **NOT** end a markdow ✔ `This is OK\` ```` -Doing it this way will prevent `pandoc(1)` from generating deprecated HTML elements such as `
`. +Doing it this way will prevent `pandoc(1)` from generating deprecated +HTML elements such as `
`.
@@ -285,21 +327,28 @@ Instead of using this markdown element to embed an image: alt="describe the filename.png image for someone who cannot view it" width=PIXEL_WIDTH height=PIXEL_HEIGHT> - 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 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. +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.
## Please do NOT use markdown style horizontal lines -Please do **NOT** use `---` style lines in markdown to create horizontal lines or to separate sections. +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). +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. +Such markdown causes `pandoc(1)` to generate `
`. The `
` has +no effect in standard HTML 5 and interacts badly with unquoted attribute +values. If a horizontal line is really needed, use: @@ -329,7 +378,8 @@ If a horizontal line is really needed, use:
## Do not end markdown links with "`))`" -Markdown links that end in "`))`" complicate parsing and sometimes lead to incorrect URLs or file paths. +Markdown links that end in "`))`" complicate parsing and sometimes lead +to incorrect URLs or file paths. ``` ✕ [some text](https://example.com/foo_(bar)) @@ -342,10 +392,10 @@ Markdown links that end in "`))`" complicate parsing and sometimes lead to incor
## 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_**. +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_**. ``` ✕ *this text is italic* @@ -355,6 +405,6 @@ 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. +**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. From 73add7628f654bfa3e9cdfe8e5c79739a391e43f Mon Sep 17 00:00:00 2001 From: Anthony Howe Date: Mon, 24 Nov 2025 04:08:58 -0500 Subject: [PATCH 3/3] Change Unicode characters for alternative coloured TICK & check marks. Remove `Tips for vim` users - do you provide the Emacs equivalent, or Nano, Joe, etc. - how to use an editor is not our job. --- markdown.md | 347 +++++++++++++++++++++++----------------------------- 1 file changed, 156 insertions(+), 191 deletions(-) diff --git a/markdown.md b/markdown.md index 251b213c93..8049760c00 100644 --- a/markdown.md +++ b/markdown.md @@ -1,133 +1,132 @@ -
+ # IOCCC 29th Markdown Guidelines -
## Markdown Guidelines Version These [Markdown Guidelines](markdown.html) are version **28.4 2025-04-28**.
-## Markdown Guidelines 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. +## 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)". +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. - +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: ``` -✕ # Section Reserved -✕ ## Section Reserved -✔ ### Section Level 3 -✔ #### Section Level 4 -✔ ##### Section Level 5 -✔ ###### Section Level 6 +❌ # Section Reserved +❌ ## Section Reserved +✔️ ### Section Level 3 +✔️ #### Section Level 4 +✔️ ##### Section Level 5 +✔️ ###### Section Level 6 ``` -
+ ## Replace `` construct. ``` -✕ ... -✔
...
+❌ ... +✔️ ... ``` + ## Markdown links instead of `...` ``` -✕ This HTML link text works, but we prefer +✔️ [markdown link text](#link_target) ``` -
-
+
+ ## Replace `` or `` ``` -✕ striked through text -✕ HTML 5 striked through text +❌ striked through text +❌ HTML 5 striked through text -✔ HTML 5 striked through text -✔ ~~markdown striked through text~~ +✔️ HTML 5 striked through text +✔️ ~~markdown striked through text~~ ``` -
-
+
+ ## Replace `` ``` -✕ old tags -✔ HTML 5 tags +❌ old tags +✔️ HTML 5 tags ```
-
+ ## Replace `` ``` -✕ obsolete HTML -✔ monospace font -✔ `markdown style monospace` +❌ obsolete HTML +✔️ monospace font +✔️ `markdown style monospace` ``` -
-
-## Always indent code blocks 4 spaces, not tab. +
+ +## Indent code blocks by four spaces, not by TAB. ``` -✕ echo "This code block is NOT indented" +❌ echo "This code block is NOT indented" ``` We request that you indent the code block by multiples of four (4) ASCII SPACES, never TAB (␉): ```` -✔ 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. +✔️ 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. ```` Alternatively its possible to use ` ``` ` marks, without the initial four (4) space indentation. This is usually the better method. ```` -✔ ``` -✔ The same thing applies to any markdown block bracketed by ``` lines. -✔ ``` +✔️ ``` +✔️ The same thing applies to any markdown block bracketed by ``` lines. +✔️ ``` ```` -
-
-## Do not use ASCII 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. @@ -136,16 +135,16 @@ 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) +If you need to indent two (2) or more levels, use multiples of four (4) ASCII SPACES. ```` ``` -✕ ␉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. +❌ ␉We don't␉mind␉tabs␉in␉general, +❌ ␉We just ask that you NOT use them in markdown files. ``` ```` @@ -153,70 +152,37 @@ And to clarify, we are only talking about markdown files, not C code or any other non-markdown content: ```` -✔ printf("It is fine to use tabs in Obfuscated C code.\n"); -✔ /* if you wish */ +✔️ 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**: Again, you are **perfectly welcome** to use ASCII tab -characters in your C code and other non-markdown files. We simply ask -that you do **NOT** use any ASCII TAB (␉) characters in markdown files. - -
-### Tip for `vim` users +**NOTE**: Again, you are **perfectly welcome** to use ASCII tab characters +in your C code and other non-markdown files. We simply ask that +you do **NOT** use any ASCII TAB (␉) characters in markdown files. -If you use `vim` you can put in your `.vimrc` file (usually `~/.vimrc`) -the following settings to make sure the tabs are not put in without you -noticing: +
-``` -set tabstop=8 " a tab is 8 spaces (or whatever you wish it to be set to) -set softtabstop=4 " ...but when inserting/backspacing use 4 spaces -set shiftwidth=4 " ...and auto-indent 4 spaces (when autoindent is set) -set expandtab " ...expand tab into spaces -``` - -If you have file type detection enabled you can, if you prefer, have -these settings set just for markdown files: - -``` -autocmd! Filetype markdown setlocal set tabstop=8 softtabstop=4 shiftwidth=4 expandtab -``` - -This will prevent the tab key from inserting tabs; rather it will insert -four (4) spaces. - -To **VERIFY** that there are no tabs in a file you may do, in command -mode: - -``` -/\t -``` - -If you're in insert mode hit `ESC` first. - -
-
## 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. ```` -✕ ```c -✕ int main(void) {return 0;} -✕ ``` +❌ ```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: ```` -✔ ``` -✔ int main(void) {return 0;} -✔ ``` +✔️ ``` +✔️ int main(void) {return 0;} +✔️ ``` ```` **IMPORTANT**: The **initial**   **\` \` \`**   must be @@ -225,9 +191,8 @@ followed by an **ASCII SPACE**, and **THEN** an **opening** ** the **language** and **FINALLY** a **closing** "`-->`" (two "`-`"s followed by a "`>`"). -
-
+ ## Ensure blank line between code block and text. Please do **NOT** place text on the next line after a markdown code @@ -236,28 +201,28 @@ block as this makes it easier to detect when markdown code blocks are **NOT** properly indented. ```` -✕ ``` -✕ int -✕ main(int foo) -✕ { -✕ return foo; -✕ } -✕ ``` -✕ C compilers cannot be given a -Wno-main-arg-errors flag. - -✔ ``` -✔ int -✔ main(int foo) -✔ { -✔ return foo; -✔ } -✔ ``` -✔ -✔ C compilers cannot be given a -Wno-main-arg-errors flag. + ``` + int + main(int foo) + { + return foo; + } +❌ ``` +❌ C compilers cannot be given a -Wno-main-arg-errors flag. + + ``` + 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. Please do **NOT** use a trailing slash on @@ -269,61 +234,59 @@ The trailing slash on void HTML elements has no effect and interacts badly with unquoted attribute values. ``` -✕
-✕
-✕ image of a tattoo of the 1984 anonymous C code - -✔
-✔
-✔ image of a tattoo of the 1984 anonymous C code +❌
+❌
+❌ image of a tattoo of + the 1984 anonymous C code + +✔️
+✔️
+✔️ image of a tattoo of + the 1984 anonymous C code ``` -
-
-## Do not use a trailing backslash (`\`) outside of a code block +
+ +## Do not use a trailing backslash outside of a code block Unless the line is inside a markdown code block, please do **NOT** end a markdown line with a trailing backslash (`\`). Instead use a trailing `
`. ``` -✕ In markdown,\ -✕ do NOT use trailing\ -✕ backslashes outside of\ -✕ a code block - -✔ In markdown,
-✔ use trailing
-✔ br's outside of
-✔ a code block - -✔ ``` -✔ This is OK\ -✔ inside a\ -✔ markdown code\ -✔ block -✔ ``` - -✔ `This is OK\` +❌ In markdown,\ +❌ do NOT use trailing\ +❌ backslashes outside of\ +❌ a code block + +✔️ 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 Instead of using this markdown element to embed an image: ``` -✕ ![alt text](filename.png "Title") +❌ ![alt text](filename.png "Title") -✔ describe the filename.png image for someone who cannot view it @@ -336,9 +299,8 @@ and `height` information so browsers have to slow down on rendering text around the image until it can internally determine the image size.
-
-
-## Please do NOT use 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. @@ -353,43 +315,46 @@ values. If a horizontal line is really needed, use: ``` -✕ * * * -✕ - - - -✕ --- +❌ * * * +❌ - - - +❌ --- Regular divider... -✔
+✔️
A short divider... -✔
+✔️
```
+ ## Do not put a literal "`(`" or "`)`" in markdown link titles ``` -✕ [some (text)](https://example.com/curds) -✔ [some (text)](https://example.com/curds) +❌ [some (text)](https://example.com/curds) +✔️ [some (text)](https://example.com/curds) -✕ [ls(1)](https://example.com/ls-man-page.1) -✔ [ls(1)](https://example.com/ls-man-page.1) +❌ [ls(1)](https://example.com/ls-man-page.1) +✔️ [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. ``` -✕ [some text](https://example.com/foo_(bar)) -✔ [some text](https://example.com/foo_(bar)) +❌ [some text](https://example.com/foo_(bar)) +✔️ [some text](https://example.com/foo_(bar)) -✕ This thing, ([some text](some/path)), is NOT ideal. -✔ This thing, [some text](some/path), is better. +❌ This thing, ([some text](some/path)), is NOT ideal. +✔️ This thing, [some text](some/path), is better. ```
+ ## Use `_` for italics in markdown Please do **NOT** use `*` (single asterisk) for italics in markdown. @@ -398,12 +363,12 @@ parsing and sometimes lead to incorrect results. This can especially go for when it is **_bold and italic_**. ``` -✕ *this text is italic* -✔ _this text is italic_ +❌ *this text is italic* +✔️ _this text is italic_ -✕ ***this text is bold italic*** -✔ **_this text is bold italic_** -✔ _**this text is bold italic**_ +❌ ***this text is bold 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