You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
outline: bullets with a hierarchical number at the start of the link text:
* [1. Title one](#title-one)
* [1.1. Section](#section)
* [2. Title two](#title-two)
The number follows the heading tree: the parent of an entry is the nearest previous
entry with a lower level. So a skipped level does not add a part: # then ###
gives 1. and 1.1., not 1.0.1..
Behavior in the Bash version:
Without --numbered the output does not change.
Only the entries kept by --depth are numbered.
With several inputs, the numbers of each document start from 1..
An unknown type is an error with exit code 1.
--numbered list with --indent less than 3 is an error: a child of 1. is nested
only when it is indented 3 to 6 spaces more than the parent, otherwise GitHub renders
one flat list.
Describe alternatives you've considered
Real counters in list (1., 2., 3.): GitHub uses only the first number of a
list, and a two-digit marker (10.) needs an indent of 4 for its children.
A number before the link (* 2.1. [Section](#section)): GitHub parses 2.1. as an
ordered list marker inside the bullet.
One counter per heading level instead of the tree: it gives the same number twice for #, ###, ## (1.1. and 1.1.).
Additional context
Differences from the Bash version to decide on:
The default --indent here is 2, so the Bash rule above would make --numbered list fail without an explicit --indent 3.
Entries here are indented relative to the top level of the document and to --start-depth. Entries skipped by --start-depth should not be numbered either.
Activity