{"id":36095,"date":"2017-09-13T10:32:04","date_gmt":"2017-09-13T10:32:04","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/devops\/?p=36095"},"modified":"2019-02-14T15:51:12","modified_gmt":"2019-02-14T23:51:12","slug":"visual-studio-marketplace-is-moving-to-a-new-markdown-parser","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/devops\/visual-studio-marketplace-is-moving-to-a-new-markdown-parser\/","title":{"rendered":"Visual Studio Marketplace is moving to a new markdown parser"},"content":{"rendered":"<h2><\/h2>\n<p><a href=\"https:\/\/marketplace.visualstudio.com\/\">Visual Studio Marketplace<\/a> is moving\u00a0its markdown parser to <a href=\"https:\/\/github.com\/markdown-it\/markdown-it\">markdown-it<\/a> which is based on the CommonMark specification. If you are a Visual Studio Team Services (VSTS) extension publisher, this would impact formatting of your extension markdown content and thus its presentation to marketplace users. Impacted extension content is:<\/p>\n<ul>\n<li>Extension details page (overview.md)<\/li>\n<li>License<\/li>\n<li>Pricing<\/li>\n<li>Privacy<\/li>\n<li>Change log<\/li>\n<\/ul>\n<p>Based on our analysis, approx. 1\/3<sup>rd<\/sup> of VSTS extensions need to be updated to ensure consistent formatting. The key impacted areas we found were multi-level lists, embedded links and images inside HTML.<\/p>\n<p>To help VSTS publishers smoothly transition to the new markdown parser, we have enabled a \u2018try it\u2019 experience on the extension details page.<\/p>\n<p><strong>How do you know if your VSTS extension content is impacted?<\/strong><\/p>\n<ul>\n<li>Log in to Visual Studio Marketplace and browse to your extension<\/li>\n<li>You can view the experience to test your extension content with the new markdown parser<img decoding=\"async\" width=\"1206\" height=\"326\" class=\"alignnone size-full wp-image-36096\" alt=\"\" src=\"https:\/\/devblogs.microsoft.com\/devops\/wp-content\/uploads\/sites\/6\/2017\/09\/Untitled2.png\" \/><\/li>\n<\/ul>\n<ul>\n<li>\u2018Click here\u2019 opens the page in a new tab to help you compare the content and formatting with the new markdown<\/li>\n<\/ul>\n<p><strong>What do you do next?<\/strong><\/p>\n<ul>\n<li>If you are happy with the content formatting with the new markdown parser, no action is required; on December 1<sup>st<\/sup>, your extension will start using the new parser.<\/li>\n<li>If you\u2019d like to change\/update the content or remove the &#8216;try it\u2019 experience on your extension details page\n<ul>\n<li>Update the extension with the new content. You can test the content using the <a href=\"https:\/\/marketplace.visualstudio.com\/items?itemName=ms-devlabs.extension-manifest-editor\">Manifest editor<\/a> extension in VSCode.<\/li>\n<li>Set the below flag in the extension manifest file to use the new parser for your extension<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p><em>\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0&#8220;galleryProperties&#8221;: [{ &#8220;<\/em><em>markdownItParser&#8221;: &#8220;true&#8221;<\/em><em>\u00a0}]<\/em><\/p>\n<ul>\n<li style=\"list-style-type: none\">\n<ul>\n<li>\ufffcUpdate your extension VSIX using TFX CLI or from the publisher&#8217;s<a href=\"https:\/\/marketplace.visualstudio.com\/manage\">\ufffc<\/a>\ufffc <a href=\"https:\/\/marketplace.visualstudio.com\/manage\">manage<\/a>\u00a0page. Note: Ensure to update to the latest TFX CLI version 0.4.10.<\/li>\n<li>Browse to the extension and ensure the content formatting is as expected<\/li>\n<li>If the content needs further updates or you need more bake time you can switch back to the older parser by setting the <em>markdownItParse\u00a0<\/em>property to false.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p>All new extensions published henceforth will use the new markdown-it parser.<\/p>\n<p>For VSCode publishers, there isn\u2019t any impact as VSCode already uses markdown-it parser.<\/p>\n<blockquote><p>The new markdown-it parser will be mandated starting December 1<sup>st<\/sup>, 2017 so please\u00a0review and update extension content before this date for well formatted content on marketplace. Note, no content will be lost.<\/p><\/blockquote>\n<p>Thank you for publishing your extension and contributing to our thriving ecosystem. We appreciate you being part of our community.<\/p>\n<p>Please reach out to the <a href=\"mailto:vsmarketplace@microsoft.com\">Marketplace team<\/a> if you have any questions \/ feedback.<\/p>\n<p>Thank you,<\/p>\n<p>Divya Vaishnavi | Program Manager | Visual Studio Marketplace<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Visual Studio Marketplace is moving\u00a0its markdown parser to markdown-it which is based on the CommonMark specification. If you are a Visual Studio Team Services (VSTS) extension publisher, this would impact formatting of your extension markdown content and thus its presentation to marketplace users. Impacted extension content is: Extension details page (overview.md) License Pricing Privacy Change [&hellip;]<\/p>\n","protected":false},"author":237,"featured_media":45953,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[229,1],"tags":[],"class_list":["post-36095","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-community","category-devops"],"acf":[],"blog_post_summary":"<p>Visual Studio Marketplace is moving\u00a0its markdown parser to markdown-it which is based on the CommonMark specification. If you are a Visual Studio Team Services (VSTS) extension publisher, this would impact formatting of your extension markdown content and thus its presentation to marketplace users. Impacted extension content is: Extension details page (overview.md) License Pricing Privacy Change [&hellip;]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/posts\/36095","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/users\/237"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/comments?post=36095"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/posts\/36095\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/media\/45953"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/media?parent=36095"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/categories?post=36095"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/tags?post=36095"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}