civicrm / civicrm-user-guide

Documentation for CiviCRM users
https://docs.civicrm.org/user/en/latest/
54 stars 146 forks source link

Fix markdown difference between github and mkdocs #415

Closed demeritcowboy closed 4 years ago

demeritcowboy commented 4 years ago

I didn't realize the bullets markdown on github is different. @MikeyMJCO

homotechsual commented 4 years ago

We don't use - markup for bullets. It needs to be * followed by two spaces please.

e.g: * some text

demeritcowboy commented 4 years ago

Oh ok. I copied from lower down in the same file.

homotechsual commented 4 years ago

The other references to the - syntax will get fixed when we start linting docs :-)

demeritcowboy commented 4 years ago

Ok thanks!

demeritcowboy commented 4 years ago

Argh they're still squished.

homotechsual commented 4 years ago

They are? - Yes they are!

demeritcowboy commented 4 years ago

Yes and I'm trying to find an example with bullets and everything I see is dashes.

homotechsual commented 4 years ago

https://docs.civicrm.org/dev/en/latest/documentation/markdown/#lists

demeritcowboy commented 4 years ago

Hmm maybe just 1 space after the star then. Will try that.

homotechsual commented 4 years ago

For this use case however I think numbered lists would be better?

Syntax:

1. List Item 1
1. List Item 2

E.g:

  1. List Item 1
  2. List Item 2
homotechsual commented 4 years ago

For bulleted lists however (if you wish!)

*  Bullet 1
*  Bullet 2

E.g:

demeritcowboy commented 4 years ago

ok

homotechsual commented 4 years ago

1 or 2 spaces should both work really.

demeritcowboy commented 4 years ago

Maybe it needs a blank line above the list. Will do that too.

homotechsual commented 4 years ago

Ah - yes it does. Sorry didn't spot that was missing!