this is a demonstration of a bug in github's markdown rendering with tabs.. in code blocks nested under bullets, lines are rendered with an extra leading space character..
alpha
alpha
alpha
alpha
alpha
bravo
bravo
bravo
bravo
bravo
charlie
charlie
charlie
charlie
charlie
delta
delta
delta
delta
delta
echo
echo
echo
echo
echo
foxtrot
foxtrot
foxtrot
foxtrot
foxtrot
I don't get it
i'll try to explain this more clearly:
if you are using tabs for indentation in a markdown github readme (which is nice because, with tabs, the indents are now displayed in accordance with the user's own preferences) — the problem is that there is a bug on github, where the text in some codeblocks is actually mangled — unwanted spacebar characters are inserted into the codeblock where none exist in the markdown source — this will cause confusing failures when somebody copy-and-pastes code snippets, because some programming languages require strictly correct indentation.
for more context, see this community discussion, and this one too.
Great visual.