1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-11-22 23:02:42 +01:00

Improve Remarkup list documentation for D1660

Summary: Document "--" list sytle and improve explicitness of list documentation
in general.

Test Plan: Generated, read documentation.

Reviewers: btrahan

Reviewed By: btrahan

CC: aran, epriestley

Differential Revision: https://secure.phabricator.com/D1661
This commit is contained in:
epriestley 2012-02-22 10:06:52 -08:00
parent 84afd3d469
commit 5c5514b948

View file

@ -96,19 +96,48 @@ You can make numbered lists with a "#" instead of "-" or "*":
You can also nest lists: You can also nest lists:
```- Body
- Head
- Arm
- Elbow
- Hand
# Thumb
# Index
# Middle
# Ring
# Pinkie
- Leg
- Knee
- Foot```
...which produces:
- Body - Body
- Head - Head
- Arm - Arm
- Elbow - Elbow
- Hand - Hand
# Thumb # Thumb
# Index # Index
# Middle # Middle
# Ring # Ring
# Pinkie # Pinkie
- Leg - Leg
- Knee - Knee
- Foot - Foot
If you prefer, you can indent lists using multiple characters to show indent
depth, like this:
```- Tree
-- Branch
--- Twig```
As expected, this produces:
- Tree
-- Branch
--- Twig
Make **code blocks** by indenting two spaces: Make **code blocks** by indenting two spaces: