Skip to content

Latest commit

 

History

History
94 lines (61 loc) · 2.55 KB

README.md

File metadata and controls

94 lines (61 loc) · 2.55 KB
Raw

kingraph

License: MIT Code Climate contributions welcome

👪 Plots family trees using JavaScript and Graphviz

A family tree plotter with a very simple syntax. It probably doesn't cover everything bigger tools do, but covers 90% of it for the sake of simplicity.

Example Graph

Installation

npm install -g alexanderwillner/kingraph

This adds the kingraph command to your shell. With kingraph --help you can get basic information on how to execute the tool.

Getting started

A family tree is a YAML file. To get started, store the following text in a file called family.yaml:

families:
  - parents: [Marge, Homer]
    children: [Bart, Lisa, Maggie]
  - parents: [Lisa, Milhouse]
    children: [Zia]

people:
  Marge:
    fullname: Marjorie Bouvier Simpson
kingraph family.yaml -F dot | dot -Tpdf -o family.pdf
open family.pdf

Further Examples

Spoiler alerts, view at your own risk :)

Simpsons (simple)

Source: simpsons.yaml

Simpsons Example

Modern Family (simple with houses)

Source: modernfamily.yaml

Modern Family Example

Harry Potter (larger tree)

Source: potter.yaml

Potter Example

Game of Thrones (overly complicated)

Source: got.yaml

GOT Example

Documentation

For further reading:

Thanks

Authored and initially maintained by Rico Sta. Cruz with help from contributors (list).

ricostacruz.com  ·  GitHub @rstacruz  ·  Twitter @rstacruz