Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 2.29 KB

README.md

File metadata and controls

108 lines (73 loc) · 2.29 KB
Raw

kingraph

👪 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.

Installation

npm install -g rstacruz/kingraph
# or
yarn global add rstacruz/kingraph  # via yarnpkg.com

This adds the kingraph command to your shell.

kingraph --help
kingraph family.yml > family.svg

Examples

Spoiler alerts, view at your own risk :)

Simpsons (simple)

Source: simpsons.yml

Modern Family (simple with houses)

Source: modernfamily.yml

Harry Potter (larger tree)

Source: potter.yml

Game of Thrones (overly complicated)

Source: got.yml

Getting started

A family tree is a YAML file.

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

people:
  Marge:
    fullname: Marjorie Bouvier Simpson

kingraph can give you svg (default), png or dot files.

kingraph family.yml > family.svg
kingraph family.yml -F png > family.png
kingraph family.yml -F dot > family.dot

See Getting started for more!

Documentation

For further reading:

Thanks

kingraph © 2016+, Rico Sta. Cruz. Released under the MIT License.
Authored and maintained by Rico Sta. Cruz with help from contributors (list).

ricostacruz.com  ·  GitHub @rstacruz  ·  Twitter @rstacruz