Giter Site home page Giter Site logo

draw2md's Introduction

DrawIO Diagram to Markdown

This is a tool to parse a DrawIO exported XML file and generate the markdown doc. The gist is that you only need to maintain the diagrams.

How to use

Draw any diagram on DrawIO, add your note to:

  1. On the diagram page (not to select any object), add note attribute.

  2. Select any element, add tooltip attribute.

  3. Export the diagram as XML file.

  4. Export the diagram as PNG images. (Not necessary, it should be able to generate SVG/PNG directly adcording to the XML, save it for later implementation).

  5. Run this tool.

    draw2md --assets <folder> --name <DiagramName>
    

Features

  • Image as data url, so you only see one markdown file.
  • Organize objects by tab.

Enjoy!

draw2md's People

Contributors

wliu-zuora avatar

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.