Jinja2 / Mustache syntax incompatibility

[wojciechczerniak]

Markdown publisher generates attr_list without space after first curly bracket

ie. {#SRS-001 } instead { #SRS-001 }

This may create a problem when we want to render the output markdown documents in any system that uses those markup extensions ie. some documentation engines that are using markdown as content. They recognize {# as a starting block for various block types.

I think that here:

doorstop/doorstop/core/publisher.py

Lines 496 to 498 in a770dc4

	def _format_md_attr_list(item, linkify):
	"""Create a Markdown attribute list for a heading."""
	return " {{#{u} }}".format(u=item.uid) if linkify else ''

a very small change will solve the issue:

-return " {{#{u} }}".format(u=item.uid) if linkify else ''
+return " {{ #{u} }}".format(u=item.uid) if linkify else ''

[wojciechczerniak]

⚠️ I found an issue #469 that suggest removing the spaces instead adding them. Should be examined carefully

[neerdoc]

I believe that the default functionality should be as in #469, i.e., no spaces. This is since Jinja2/Mustache syntax are markdown extensions.

If this is a requested feature (to use specific markdown extensions), it should be added as a flag, e.g., --mustache-compatible or similar.

[wojciechczerniak]

I second that that there should be no spaces as default. But instead introducing flags I would focus on #515 to allow the necessary customizations for even more extensions than we can think off. I didn't close this issue after creating #515 because I see it as a good use case for templating engine