/graphviz-tutorial

how do I graphviz? oh I see!

Primary LanguageShell

Graphviz is like markdown, for diagrams.

It's a tool that can transform text input into a "directed graph" output, which is nodes pointing to other nodes. You can use it for architecture diagrams, DB diagrams, documentation for users, etc.

graphviz-it

Graphviz Tutorial

This is a step by step tutorial, introducing commonly used features of graphviz one at a time.

Goals

By the end, we'll produce this diagram.

output image

You'll learn about:

  • nodes & connections
  • how to style connections (nodes are similar)
  • how to do multiline text in nodes
  • grouping nodes using subgraphs
  • applying styles globally
  • ordering affects how it's drawn
  • specify where on the node the connection attachmes

How to navigate this repo

To start, open the commits tab and open each commit from bottom to top - each one in its own tab.

Here is an example of what the commit view looks like

  • the description in the commit at the top describes the change
  • you can see both the text changes and the image changes

example commit image

Using graphviz on your own

You'll want to use a tool with a two-pane layout - the left side is the source text, the right side is the image output.

Keeping track of diagrams

You should keep track of your diagrams somewhere - I recommend in a github repo. Suggestion-instructions here in this gist.