SimDem2 Feature: Ensure compliance with Markdownlint

[lastcoolnameleft]

It's come to my attention that SimDem1 syntax doesn't comply with Markdownlint:

https://github.com/markdownlint/markdownlint

We might need to reconsider the format of SimDem documents.

[SorraTheOrc]

It's a design goal that it is markdown compatible. Though I confess that I have not been linting. We should fix this, even if it means backward incompatible changes.

Do you have a failure report?

[lastcoolnameleft]

To test, I followed the instructions on https://github.com/markdownlint/markdownlint and ran mdl on the demo_scripts directory.

➜  simdem git:(upstream) ✗ mdl demo_scripts
demo_scripts/test/environment_test.md:141: MD009 Trailing spaces
demo_scripts/test/environment_test.md:23: MD012 Multiple consecutive blank lines
demo_scripts/test/environment_test.md:118: MD012 Multiple consecutive blank lines
demo_scripts/test/environment_test.md:16: MD013 Line length
demo_scripts/test/environment_test.md:32: MD013 Line length
demo_scripts/test/environment_test.md:63: MD013 Line length
demo_scripts/test/environment_test.md:129: MD025 Multiple top level headers in the same document
demo_scripts/test/environment_test.md:154: MD025 Multiple top level headers in the same document
demo_scripts/test/environment_test.md:171: MD025 Multiple top level headers in the same document
demo_scripts/test/environment_test.md:189: MD025 Multiple top level headers in the same document
demo_scripts/test/prerequisites/nested_prereq.md:5: MD025 Multiple top level headers in the same document
demo_scripts/test/prerequisites/nested_prereq.md:11: MD025 Multiple top level headers in the same document
demo_scripts/test/prerequisites/passing_prerequisite.md:18: MD025 Multiple top level headers in the same document
demo_scripts/test/prerequisites/README.md:8: MD025 Multiple top level headers in the same document
demo_scripts/test/prerequisites/README.md:12: MD025 Multiple top level headers in the same document
demo_scripts/test/prerequisites/README.md:18: MD025 Multiple top level headers in the same document
demo_scripts/test/directory/README.md:21: MD009 Trailing spaces
demo_scripts/test/README.md:67: MD009 Trailing spaces
demo_scripts/test/README.md:75: MD009 Trailing spaces
demo_scripts/test/README.md:76: MD009 Trailing spaces
demo_scripts/test/README.md:79: MD009 Trailing spaces
demo_scripts/test/README.md:108: MD009 Trailing spaces
demo_scripts/test/README.md:60: MD012 Multiple consecutive blank lines
demo_scripts/test/README.md:6: MD025 Multiple top level headers in the same document
demo_scripts/test/README.md:33: MD025 Multiple top level headers in the same document
demo_scripts/test/README.md:61: MD025 Multiple top level headers in the same document
demo_scripts/test/README.md:73: MD025 Multiple top level headers in the same document
demo_scripts/test/README.md:85: MD025 Multiple top level headers in the same document
demo_scripts/test/README.md:98: MD025 Multiple top level headers in the same document
demo_scripts/test/README.md:114: MD025 Multiple top level headers in the same document
demo_scripts/test/README.md:141: MD025 Multiple top level headers in the same document
demo_scripts/test/remote/README.md:10: MD025 Multiple top level headers in the same document
demo_scripts/test/remote/README.md:17: MD025 Multiple top level headers in the same document
demo_scripts/test/remote/README.md:8: MD029 Ordered list item prefix
demo_scripts/README.md:5: MD006 Consider starting bulleted lists at the beginning of the line
demo_scripts/README.md:7: MD009 Trailing spaces
demo_scripts/README.md:10: MD009 Trailing spaces
demo_scripts/README.md:11: MD022 Headers should be surrounded by blank lines
demo_scripts/README.md:15: MD025 Multiple top level headers in the same document
demo_scripts/README.md:18: MD029 Ordered list item prefix
demo_scripts/simdem/demo/README.md:27: MD009 Trailing spaces
demo_scripts/simdem/demo/README.md:18: MD013 Line length
demo_scripts/simdem/demo/README.md:35: MD025 Multiple top level headers in the same document
demo_scripts/simdem/demo/README.md:63: MD025 Multiple top level headers in the same document
demo_scripts/simdem/demo/README.md:70: MD029 Ordered list item prefix
demo_scripts/simdem/demo/README.md:71: MD029 Ordered list item prefix
demo_scripts/simdem/running/README.md:25: MD025 Multiple top level headers in the same document
demo_scripts/simdem/running/README.md:41: MD025 Multiple top level headers in the same document
demo_scripts/simdem/running/README.md:51: MD025 Multiple top level headers in the same document
demo_scripts/simdem/running/README.md:54: MD029 Ordered list item prefix
demo_scripts/simdem/running/README.md:55: MD029 Ordered list item prefix
demo_scripts/simdem/running/README.md:56: MD029 Ordered list item prefix
demo_scripts/simdem/tutorial/README.md:3: MD009 Trailing spaces
demo_scripts/simdem/tutorial/README.md:36: MD025 Multiple top level headers in the same document
demo_scripts/simdem/tutorial/README.md:44: MD029 Ordered list item prefix
demo_scripts/simdem/tutorial/README.md:45: MD029 Ordered list item prefix
demo_scripts/simdem/tutorial/README.md:40: MD034 Bare URL used
demo_scripts/simdem/modes/README.md:49: MD001 Header levels should only increment by one level at a time
demo_scripts/simdem/modes/README.md:6: MD006 Consider starting bulleted lists at the beginning of the line
demo_scripts/simdem/modes/README.md:77: MD025 Multiple top level headers in the same document
demo_scripts/simdem/modes/README.md:90: MD025 Multiple top level headers in the same document
demo_scripts/simdem/modes/README.md:93: MD029 Ordered list item prefix
demo_scripts/simdem/modes/README.md:94: MD029 Ordered list item prefix
demo_scripts/simdem/modes/README.md:95: MD029 Ordered list item prefix
demo_scripts/simdem/test/README.md:6: MD009 Trailing spaces
demo_scripts/simdem/test/README.md:18: MD009 Trailing spaces
demo_scripts/simdem/test/README.md:36: MD009 Trailing spaces
demo_scripts/simdem/test/README.md:54: MD009 Trailing spaces
demo_scripts/simdem/test/README.md:13: MD013 Line length
demo_scripts/simdem/test/README.md:84: MD025 Multiple top level headers in the same document
demo_scripts/simdem/test/README.md:87: MD029 Ordered list item prefix
demo_scripts/simdem/test/README.md:88: MD029 Ordered list item prefix
demo_scripts/simdem/test/README.md:89: MD029 Ordered list item prefix
demo_scripts/simdem/prerequisites/README.md:52: MD009 Trailing spaces
demo_scripts/simdem/prerequisites/README.md:77: MD009 Trailing spaces
demo_scripts/simdem/prerequisites/README.md:78: MD013 Line length
demo_scripts/simdem/prerequisites/README.md:13: MD025 Multiple top level headers in the same document
demo_scripts/simdem/prerequisites/README.md:22: MD025 Multiple top level headers in the same document
demo_scripts/simdem/prerequisites/README.md:59: MD025 Multiple top level headers in the same document
demo_scripts/simdem/prerequisites/README.md:87: MD025 Multiple top level headers in the same document
demo_scripts/simdem/prerequisites/README.md:90: MD029 Ordered list item prefix
demo_scripts/simdem/prerequisites/README.md:91: MD029 Ordered list item prefix
demo_scripts/simdem/prerequisites/README.md:92: MD029 Ordered list item prefix
demo_scripts/simdem/prerequisites/README.md:93: MD029 Ordered list item prefix
demo_scripts/simdem/prerequisites/README.md:94: MD029 Ordered list item prefix
demo_scripts/simdem/README.md:44: MD005 Inconsistent indentation for list items at the same level
demo_scripts/simdem/README.md:5: MD006 Consider starting bulleted lists at the beginning of the line
demo_scripts/simdem/README.md:7: MD009 Trailing spaces
demo_scripts/simdem/README.md:10: MD009 Trailing spaces
demo_scripts/simdem/README.md:47: MD009 Trailing spaces
demo_scripts/simdem/README.md:46: MD012 Multiple consecutive blank lines
demo_scripts/simdem/README.md:47: MD012 Multiple consecutive blank lines
demo_scripts/simdem/README.md:11: MD022 Headers should be surrounded by blank lines
demo_scripts/simdem/README.md:30: MD025 Multiple top level headers in the same document
demo_scripts/simdem/README.md:36: MD029 Ordered list item prefix
demo_scripts/simdem/README.md:37: MD029 Ordered list item prefix
demo_scripts/simdem/README.md:38: MD029 Ordered list item prefix
demo_scripts/simdem/README.md:39: MD029 Ordered list item prefix
demo_scripts/simdem/README.md:40: MD029 Ordered list item prefix
demo_scripts/simdem/README.md:41: MD029 Ordered list item prefix
demo_scripts/simdem/README.md:42: MD029 Ordered list item prefix
demo_scripts/simdem/README.md:43: MD029 Ordered list item prefix
demo_scripts/simdem/README.md:44: MD029 Ordered list item prefix
demo_scripts/simdem/multipart/README.md:38: MD009 Trailing spaces
demo_scripts/simdem/multipart/README.md:49: MD009 Trailing spaces
demo_scripts/simdem/multipart/README.md:95: MD009 Trailing spaces
demo_scripts/simdem/multipart/README.md:105: MD009 Trailing spaces
demo_scripts/simdem/multipart/README.md:106: MD009 Trailing spaces
demo_scripts/simdem/multipart/README.md:95: MD010 Hard tabs
demo_scripts/simdem/multipart/README.md:106: MD012 Multiple consecutive blank lines
demo_scripts/simdem/multipart/README.md:22: MD025 Multiple top level headers in the same document
demo_scripts/simdem/multipart/README.md:28: MD025 Multiple top level headers in the same document
demo_scripts/simdem/multipart/README.md:41: MD025 Multiple top level headers in the same document
demo_scripts/simdem/multipart/README.md:68: MD025 Multiple top level headers in the same document
demo_scripts/simdem/multipart/README.md:74: MD025 Multiple top level headers in the same document
demo_scripts/simdem/multipart/README.md:98: MD025 Multiple top level headers in the same document
demo_scripts/simdem/multipart/README.md:101: MD029 Ordered list item prefix
demo_scripts/simdem/multipart/README.md:102: MD029 Ordered list item prefix
demo_scripts/simdem/multipart/README.md:103: MD029 Ordered list item prefix
demo_scripts/simdem/multipart/README.md:104: MD029 Ordered list item prefix
demo_scripts/simdem/variables/README.md:41: MD009 Trailing spaces
demo_scripts/simdem/variables/README.md:50: MD009 Trailing spaces
demo_scripts/simdem/variables/README.md:70: MD009 Trailing spaces
demo_scripts/simdem/variables/README.md:41: MD010 Hard tabs
demo_scripts/simdem/variables/README.md:58: MD012 Multiple consecutive blank lines
demo_scripts/simdem/variables/README.md:40: MD013 Line length
demo_scripts/simdem/variables/README.md:163: MD025 Multiple top level headers in the same document
demo_scripts/simdem/variables/README.md:166: MD029 Ordered list item prefix
demo_scripts/simdem/variables/README.md:167: MD029 Ordered list item prefix
demo_scripts/simdem/variables/README.md:168: MD029 Ordered list item prefix
demo_scripts/simdem/syntax/README.md:13: MD009 Trailing spaces
demo_scripts/simdem/syntax/README.md:89: MD013 Line length
demo_scripts/simdem/syntax/README.md:16: MD025 Multiple top level headers in the same document
demo_scripts/simdem/syntax/README.md:23: MD025 Multiple top level headers in the same document
demo_scripts/simdem/syntax/README.md:113: MD025 Multiple top level headers in the same document
demo_scripts/simdem/syntax/README.md:53: MD029 Ordered list item prefix
demo_scripts/simdem/syntax/README.md:116: MD029 Ordered list item prefix
demo_scripts/simdem/syntax/README.md:117: MD029 Ordered list item prefix
demo_scripts/simdem/syntax/README.md:118: MD029 Ordered list item prefix
demo_scripts/simdem/syntax/README.md:119: MD029 Ordered list item prefix
demo_scripts/simdem/syntax/README.md:120: MD029 Ordered list item prefix
demo_scripts/simdem/building/README.md:7: MD009 Trailing spaces
demo_scripts/simdem/building/README.md:11: MD025 Multiple top level headers in the same document

[SorraTheOrc]

Thanks,

That's all trivial stuff that is easily rectifiable. I see nothing in there that will impact the parsing of the documents.