fatfree icon indicating copy to clipboard operation
fatfree copied to clipboard

Error in documentation / bug in Markdown

Open aleroma opened this issue 10 years ago • 6 comments

Here wrong example for <exclude> alias - {<em> text-block </em>}. It seems that correct example should be - {*<em> text-block </em>*}.

aleroma avatar Jan 27 '16 20:01 aleroma

Thanks for the report. Please use the documentation's issue tracker (F3Community/F3com-data/issues) for future findings.


That's a tricky Markdown parser problem. I am not sure if it's possible to create inline <code> tags with the current parser without evaluating the tag's content (e.g. *italics*). Replacing

`{* text-block *}`

with

```{* text-block *}```

or

<code>* text-block *</code>

doesn't fix the problem and

\```
{* text-block *}
\```

(without the \) isn't a valid solution as it breaks the listing.


(GitHub doesn't interpret code tag values and parses it as expected.)

Rayne avatar Jan 27 '16 21:01 Rayne

Looks like a bug in the markdown library as the original spec states:

Regular Markdown syntax is not processed within code blocks. E.g., asterisks are just literal asterisks within a code block.

For now, I've encoded asterisks: https://github.com/F3Community/F3com-data/commit/6e92f0fa21151c01406816547e8eeeebccf18b83

xfra35 avatar Jan 28 '16 07:01 xfra35

Well done! Thanks for quick fixing. Who can close the issue?

aleroma avatar Jan 29 '16 09:01 aleroma

Well before closing it, the question is: do we fix the Markdown class or not?

xfra35 avatar Jan 29 '16 09:01 xfra35

I didn't expect this behaviour, so :+1: for fixing instead of working around with encoded characters.

Rayne avatar Jan 29 '16 09:01 Rayne

No objections here

bcosca avatar Feb 01 '16 07:02 bcosca