Poll: What standards do we want to promote for markdown code?

Created by: seancolsen

What standards do we want to promote for markdown code?

In issue #24 (closed), most people supported gently recommending some markdown code standards to be upheld in the writing of documentation guides in mkdocs. This issue is to help us decide what goes in these standards. Please vote by adding a comment with your choices on the following questions, and I will do my best to facilitate a decision that satisfies everyone.

Line length:

• Option 0: No standard
• Option 1: Hard-wrapping at 80 characters (when possible)
• Option 2: Each paragraph or list-item is kept on its own line
• Option 3: Each sentence is kept on its own line (with single line breaks between sentences within the same paragraph).

Ordered lists:

• Option 0: No standard
• Option 1: Use 1. for all list items
• Option 2: Use 1., then 2., then 3., etc.

Unordered lists:

• Option 0: No standard
• Option 1: Use - to delimit list items
• Option 2: Use * to delimit list items

List spacing:

• Option 0: No standard
• Option 1: Clean spacing, by starting list item content 4 characters in to align with nested lists. (e.g. unordered item is: dash (or asterisk), then three spaces, then content.)
• Option 2: Simple spacing by using the delimiter, then one space, then content

Headings:

• Option 0: No standard
• Option 1: Use hash syntax for headings

Location:

• Option 1: Have a dedicated (but small) page for markdown code standards
• Option 2: Integrate markdown code standards into the page on markdown syntax
• Option 3: Integrate markdown code standards into the (up and coming) Style Guide

A sample ballot for you to copy-paste-edit:

- Line length: 2
- Ordered lists: 0
- Unordered lists: anything but 2
- List spacing: 0
- Headings: 1
- Location: don't care