fix 1992/westley/README.md, warn about TAB intending in markdown.md
One must **NOT** use ASCII TAB characters to intent text. Down the TAB-ed road is nothing but trouble! There are _quasi-solutions_, however those have side effects that lead to a different set of problems. The `markdown.md` was updated to ask that text not be intended with ASCII tabs. See [Please do NOT use ASCII tabs to indent text](https://ioccc-src.github.io/temp-test-ioccc/markdown.html#markdown.html#please-do-not-specify-a-language-for-a-code-block). We discovered this awhile ago and fixed it in markdown files. Sorry (tm Canada 🇨🇦), we forgot to mention this this in `markdown.md`. BTW: It took some **deep magic** to be able to show an HTML comment after a starting fenced markdown code block! See the **NO_COMMENT=** line in `bin/md2html.cfg`. :-) TODO: Stamp out indenting TABs in markdown files, especially in code blocks. TODO: Consider a rule to detect problematic ASCII TAB intendation within makrkdown files.
This commit is contained in:
1 parent
27d6eddf3b
commit
affbd30553
5 files changed
+90
-12
No files matched your search
+49
-1
@@ -124,7 +124,7 @@ This code block is NOT indented <=== no thank you
|
||||
````
|
||||
|
||||
|
||||
We request that you indent the code block by 4 spaces:
|
||||
We request that you indent the code block by 4 ASCII spaces
|
||||
|
||||
````
|
||||
```
|
||||
@@ -151,6 +151,54 @@ For example, `next/guidelines.md` uses this markdown code block:
|
||||
````
|
||||
|
||||
|
||||
## Please do NOT use ASCII tabs to indent text
|
||||
|
||||
When indenting a code block in markdown, indent 4 ASCII spaces per level.
|
||||
If you need to indent 2 or more levels, use multiples of 4 ASCII spaces.
|
||||
Please do **NOT** intend with ASCII tabs!
|
||||
|
||||
For example:
|
||||
|
||||
````
|
||||
```
|
||||
Please do **NOT** indent with ASCII tabs. <=== no thank you
|
||||
|
||||
The top level starts with a 4 ASCII space indent.
|
||||
|
||||
Only indend 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.
|
||||
```
|
||||
````
|
||||
|
||||
|
||||
## Please do NOT specify a language for a code block
|
||||
|
||||
We request that (fenced) markdown code blocks **NOT** specify a language.
|
||||
|
||||
For example:
|
||||
|
||||
````
|
||||
```c <=== no thank you
|
||||
int main(void) {return 0;}
|
||||
```
|
||||
````
|
||||
|
||||
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`**,
|
||||
then by an **opening** **`<!---`**, then by the **language**, then by a **closing** **`-->`**.
|
||||
|
||||
|
||||
|
||||
## Please do NOT add trailing slash to HTML elements
|
||||
|
||||
Please do **NOT** use a trailing slash on [void HTML
|
||||
|
||||
Reference in new issue
Block a user