Define format for writing guides

The goal of this task is to figure out the best format for guides.

Consider:

• extensibility
• easy to use
• popularity
• render library that we allowed to use

Issue also requires specification concerning Che actions format. Format has to be intuitively understand for Technology provider and any person who wants to write guide.

@eivantsov 's suggestion:

[action type=ide actionID=helpAboutAction]
[action type=openFile path=/path/to/file scroll=23 highlight=23:25]
[action type=command name=build and run]

Epic: https://github.com/eclipse/che/issues/6150

DoD:

• Parser in question has to cover at least MD format
• Performance tests performed to compare client side parser vs server side parser
• Proposed format for custom actions can be parsed and relatively easy to use
• License checked

Sources to look at: https://code.visualstudio.com/docs/languages/markdown

@benoitf already has made investigation, see details in comments

[AndrienkoAleksandr]

I completed investigation using markdown format for che guide. Like nice candidate I chose js library markdown-it. It quite small (106.4 Kb), quite fast and it supports extending markdown syntax with help plugins. Microsoft use this library in their vscode markdown extension. I’ve got this syntax:

[action, id="open-file", path="/path", line=30]

I wrote mockup plugin for markdown-it to support rendering che action buttons. Source code here: MarkDownItTest Github demo where is you can see rendering action buttons inside different markdown elements here: che actions plugin demo

[benoitf]

yes congrats @AndrienkoAleksandr