miguelangelorocha / azure-devops-mermaid-viewer

This Azure DevOps Extension allows to get a Preview for your Mermaid Diagram in your Code Repos

Home Page:https://marketplace.visualstudio.com/items?itemName=DanieleCas.azure-devops-mermaid-viewer

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Azure DevOps Extension: Mermaid Viewer

Overview

This Azure DevOps Extension allows to render your .mmd files on your Azure DevOps Repos. Click here to install.

Usage

Install this extension to your Azure DevOps Organization.

Go to Repos:

  • in Files: if you select a Mermaid (.mmd) file you can find a new Preview tab

    Preview Diagram

  • in Pull Requests: if you select a Mermaid (.mmd) file you can find a Raw Content/Preview toggle button

    Preview Diagram

Run Locally

To Run Locally:

  • install npm packages: npm install
  • install tfx command line: npm install -g tfx-cli

To Debug Code:
  • Create a new package for development purpose: npx tfx-cli extension create --rev-version --overrides-file configs/dev.json

  • Deploy it on Azure DevOps Extension Marketplace: https://marketplace.visualstudio.com/manage/publishers/danielecas

  • And than run local code: npx webpack-dev-server --mode development

  • Access to firefox to debug you extension

Production Deployment

To create a new package for production deployment: npx tfx-cli extension create --rev-version --env mode=production --overrides-file configs/release.json

For contributors

Contributions are welcome, Feel free to create a Pull Request or Contact me to give your suggestions



Mermaid icons created by Freepik - Flaticon

About

This Azure DevOps Extension allows to get a Preview for your Mermaid Diagram in your Code Repos

https://marketplace.visualstudio.com/items?itemName=DanieleCas.azure-devops-mermaid-viewer

License:MIT License


Languages

Language:JavaScript 56.5%Language:TypeScript 27.5%Language:HTML 16.0%