Day: July 28, 2016
This post is here in order to help you to improve quality on published extension on market place, because we have lot of extensions without documentation, so it’s very hard to use theses, we can add documentation easily by defining markdown.
We have set of steps to follow in order to document.
1. Create your markdown file , add readme.md to your library, if you have one extension library with set of task, suggest you to have one mardown for all tasks.
Remarks: Your file don’t need to be copied in content, let default options.
Below samples of common syntax of markdown :
# This is an H1
## This is an H2
###### This is an H6
This is [an example](http://www.amayestech.com/) inline link.
You can also install markdown extension in order to modify easily :
After installing Markdown Editor, can view the design of my code, view small symbol M on my file.
complete doc here : https://code.visualstudio.com/docs/languages/markdown
2. Register your readme.md file into manifeste extension by adding section of code below
3. For this sample we add images in readme.md, theses images must be copied to directory img (content / do not copy)
and registered into manifeste extension
Now after packaging and publishing actions, if we go to market place manager, we can view documentation of your extension.