Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

the docs for definition lists is not clear about the required indentation #2087

Closed
imz opened this issue Apr 16, 2015 · 1 comment
Closed

Comments

@imz
Copy link

imz commented Apr 16, 2015

I read http://pandoc.org/README.html#definition-lists and didn't understand that the first letter of the definition must be at position 5, so that there are three spaces and a single : (or ~) somehow distributed in the first 4 position in the line.

I've just figured this out experimentally.

If this is an intended feature, I suggest to write about it in the documentation.

This won't work (unexpectedly!):

term 1
: definition

term 2
 : defintion

term 3
:  definition
@jgm
Copy link
Owner

jgm commented Apr 18, 2015

I checked how PHP Markdown Extra does this, and in fact it doesn't require the indentation of the first line. So I'm going to just drop this requirement.

@jgm jgm closed this as completed in d3544dc Apr 18, 2015
jgm added a commit that referenced this issue Sep 27, 2021
In 2015, we relaxed indentation requirements for the first
line of a definition (see commit d3544dc and issue #2087), but
the documnentation wasn't updated to reflect the change.

Closes #7594.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants