Giter Site home page Giter Site logo

ado-aws-mermaid's Introduction

Azure DevOps - Drawing AWS Diagrams with Mermaid

Introduction

Ever wondered what this button does in the Azure DevOps Wiki Editor?

Azure DevOps Wiki Editor

Azure DevOps Wiki has native support for Mermaid, which means you can draw pretty good diagrams right there in your markdown:

Serverless Architecture

This is not as good as a full-featured editor like Visio, but on the other hand it is extremely easy to maintain, and Mermaid does the heavy lifting of working out how your diagram nodes are connected together.

Sample Code

You can see the code behind the diagram right here

Limitations

  1. Font Awesome is not supported by Azure DevOps Wiki, plus another couple of things (see here)
  2. It is all manual work to make Mermaid objects look vaguely AWS-like - but adding the right colours and a few different shapes goes a long way
  3. It seems that 'Provisioned' Wikis have slightly better support than 'Published' Wikis for Mermaid - special characters (&) are parsed correctly in provisioned Wikis, but are treated as syntax errors by published Wikis. (see here for intro to the differences)

Further Reading

Syntax for Mermaid Flowcharts
https://mermaid-js.github.io/mermaid/#/flowchart

Publish an Azure DevOps Git repository to a wiki
https://docs.microsoft.com/en-us/azure/devops/project/wiki/publish-repo-to-wiki?view=azure-devops&tabs=browser#publish-a-git-repository-to-a-wiki-1

ado-aws-mermaid's People

Contributors

bendalby82 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

sankha798 nqerz

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.