carwin / markdown-styleguide Goto Github PK

How about fixing the list markers?

My preferred choice are hyphens - because:

• asterisks are already used for other functions: italics and boldface
• I am yet to see someone using +

What is the rationale for the 2 space indent on every level?

I propose 4 indents on everything except first line style such as:

Par.

- very vey very
    very long l11

- l12
    - 21
    - 22
        - 31
        - 32

Rationale:

• multiple paragraphs on a list item look nicer because new pars must be indented by 4 spaces.

  Looks better:

  - l1
      - l2 par 1 line 1
          par 1 line 2
  
          par2 line 1 ALIGNED 
  

  Looks worse:

    - l1
      - l2 par 1 line 1
        par 1 line 2
  
          par2 line 1 NOT ALIGNED
  

• easier for humans to remember: always use 4 spaces on lists and code blocks.

• more common based on my subjective experience

There's a whole bunch of styles for this, so it's probably worth defining one in the styleguide:

***
* * * * *
-------------------------
_ _ _ _ _

I'm pretty sure that a line of hyphens is the most common, but it's usually a random number of hyphens. Maybe we should define it as exactly 80 so it lines up with the wrap-guide? Or should it be something shorter like 40, 20, or 10? We could go as low as 3, but then it wouldn't look much like a horizontal rule.

Thoughts?

Hello!

Is there a recommended standardization for subtitles? I've seen a few in the wild, mostly these two:

# Title
## Subtitle

### Header

Body

# Title
*Subtitle*

## Header

Body

Thanks!