Giter VIP home page Giter VIP logo

diagrammer's Introduction

Diagrammer

ASCII diagrams to pictures converter.

It is designed to be a part of an automated workflow, such as documentation or site generation, as a tool that converts diagrams drawn in ASCII art technick into bitmaps.

For example, a diagram:

 Source code/Text

        |
        v
+---------------+        +------------+
| Documentation | . . . >|            |
|               |        | Diagrammer |
|   Generator   |< . . . |            |
+-------+-------+        +------------+
        |
        v

  Documentation

will be converted into:

Usage

The only mandatory command line argument passed to the program is a file to be converted:

diagrammer <input-file>

Output

By default the output is saved in a file output.png under the current working directory. The name of the output file can be changed by passing a desired one after the --output option:

diagrammer --output diagram.png diagram.txt

Warning. If the output file exists, it will be rewritten without a notice.

Debug Mode

There is a 'debug' mode. In this mode the diagram is drawn on top of a grid. The grid's cells represent characters, therefore cells dimensions equal to maximum possible characters width and height. The mode is enabled by --debug command line option.

Philosophy

Often diagrams are parts of a source code or some documentation that must be easily comprehended in its original text representation. For this reason, ASCII diagrams must not be polluted by special commands for tools, they are processed by.

Related Projects

There are several projects with similar functionality:

Many of them as well as this one were inspired by 'ditaa'. Thanks to Stathis Sideris for such a great idea!

diagrammer's People

Contributors

evgvir avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

5l1v3r1

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.