- ago
The currently used MarkDown parser understands just the simplest constructions. It seems to have problems with unordered lists and does not support tables, code blocks, task lists and so forth.

Please update to a better MarkDown parser.

IMHO the help system is a crucial ingredient for the acceptance of the product by a broad customer base. The better the help system, the more people will like the product
and are able to use it for interesting tasks.
6
970
13 Replies

Reply

Bookmark

Sort
Glitch8
 ( 12.08% )
- ago
#1
We've looked for a better one without success. If you have any suggestions let us know.
0
- ago
#2
Perhaps you could just use HTML5 instead. Also, you could then use any HTML editor to compose it.
0
Glitch8
 ( 12.08% )
- ago
#3
That would require a complete overhaul of all the help content.

We like Markdown because it makes it easier to compose the help. We can use a plain text or simple editor.
1
- ago
#4
https://github.com/xoofx/markdig

looks promising...
1
- ago
#5
QUOTE:
We like Markdown because it makes it easier to compose the help.

I agree with that, but using HTML5 isn't that much of a burden for developers to use. And it allows you to use [1] multiple colors, [2] list types, and [3] font digbats, which aren't easily accessible in markdown. The output just looks better.

Also, most HTML editors check syntax and have previewers so you're not constantly looking through a tagging mess.
0
- ago
#6
A few MarkDown parsers will support nested HTML tags. Alternatively, some of the effects might be accomplished by the use of Emoji; in which case we would use “pure” MD.

I believe that the Marked parser supports it and has a .NET port:
https://github.com/alex-titarenko/markednet

Probably also MarkDig and MarkDownSharper.
1
- ago
#7
Did some tests with Markdig, linked above by DrKoch, and it implements the CommonMark spec, which does support inline HTML.

Example:
https://babelmark.github.io/?text=%3Cstyle%3Ep%7Bcolor%3Ablue%3B%7D%3C%2Fstyle%3E%0AWealth-Lab
1
Cone8
 ( 28.25% )
- ago
#8
QUOTE:
I agree with that, but using HTML5 isn't that much of a burden for developers
Markdown files can include HTML - and we have inserted html in some places.
1
- ago
#9
Markdig suggested by DrKoch seems to have a lower memory footprint than the current implementation (CommonMark.NET). It's also being actively developed (unlike Marked). The downside of it is slower speed compared to CM.NET.
0
Glitch8
 ( 12.08% )
- ago
#10
We're using a new one in WL8, no more CommonMark. Using the mdXaml control.

https://github.com/whistyun/MdXaml
1
- ago
#11
Is the same Markdown processor used in strategy descriptions so we can embed HTML in the Markdown? I like to include outlining in descriptions and HTML let's me do that in WL6.
0
- ago
#12
Injecting HTML tags into Markdown in the Strategy description box doesn't seem to work for me though you can use some syntax enhancements the library provides:

https://github.com/whistyun/MdXaml/blob/master/docs/original_enhance.md
0
- ago
#13
Thanks for the link. I didn't know Markdown had those extensions.

I still think supporting HTML directly as WL6 does makes the most sense since many editors support HTML rendering.
0

Reply

Bookmark

Sort