Publish Markdown reports

This is an extension for Azure Pipelines to publish Markdown files in a tab in a build result page.

I developed this extension to show Markdown files, which are automatically generated in a pipeline, such as a document generated by jsdoc-to-markdown and Doxybook2.

Overview

This extension adds a "Markdown reports" tab to a build result page as follows:

Usage

Project setting

Add this extension to your project in Marketplace page.

Pipeline setting

Add the following YAML definition in your pipeline.

- task: PublishMarkdownReports@1
  inputs:
    contentPath: $(Build.SourcesDirectory)/markdown
    indexFile: main_page.md
    headingId: doxybook2
    latexFormula: true

• contentPath specifies a root directory of your Markdown files.
• indexFile is optional. index.md is used as default.
• headingId is optional. none, pythonmarkdown, or doxybook2.
• latexFormula is optional. true, or false.

Note
Please note that all files within the contentPath are stored in Azure DevOps storage. Therefore, ensure that only the necessary files are present in the directory specified by contentPath to minimize storage usage.

3rd party libraries

This extension uses the following 3rd party libraries.

• Marked
  Christopher Jeffrey. (MIT License)
• highlight.js
  Ivan Sagalaev. (BSD 3-Clause License)
• DOMPurify
  Mario Heiderich. (Apache License)
• new.css
  Example. (MIT License)
• KaTeX
  Khan Academy and other contributors. (MIT License)

License

You can use this extension under the MIT License.
See LICENSE.txt for more details.