Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rstacruz/kingraph
Plots family trees using JavaScript and Graphviz
https://github.com/rstacruz/kingraph
family-tree genealogy graphviz
Last synced: about 2 months ago
JSON representation
Plots family trees using JavaScript and Graphviz
- Host: GitHub
- URL: https://github.com/rstacruz/kingraph
- Owner: rstacruz
- Created: 2016-11-10T01:12:46.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-23T11:24:38.000Z (almost 2 years ago)
- Last Synced: 2024-05-09T20:03:44.848Z (5 months ago)
- Topics: family-tree, genealogy, graphviz
- Language: JavaScript
- Size: 527 KB
- Stars: 430
- Watchers: 22
- Forks: 84
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://gramps-project.org/) do, but covers 90% of it for the sake of simplicity.
Installation
------------
```sh
npm install -g rstacruz/kingraph
# or
yarn global add rstacruz/kingraph # via yarnpkg.com
```
This adds the `kingraph` command to your shell.
```sh
kingraph --help
kingraph family.yml > family.svg
```
Examples
--------
Spoiler alerts, view at your own risk :)
Simpsons (simple)
Source: *[simpsons.yml](examples/simpsons.yml)*
> 
Modern Family (simple with houses)
Source: *[modernfamily.yml](examples/modernfamily.yml)*
> 
Harry Potter (larger tree)
Source: *[potter.yml](examples/potter.yml)*
> 
Game of Thrones (overly complicated)
Source: *[got.yml](examples/got.yml)*
> 
Getting started
---------------
A family tree is a [YAML](http://yaml.org/) file.
```yaml
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.
```sh
kingraph family.yml > family.svg
kingraph family.yml -F png > family.png
kingraph family.yml -F dot > family.dot
```
See [Getting started](docs/getting_started.md) for more!
Documentation
-------------
For further reading:
- [Getting started](docs/getting_started.md)
- [Advanced usage](docs/advanced.md)
- [Schema](docs/schema.md)
## Thanks
**kingraph** © 2016+, Rico Sta. Cruz. Released under the [MIT] License.
Authored and maintained by Rico Sta. Cruz with help from contributors ([list][contributors]).
> [ricostacruz.com](http://ricostacruz.com)  ·Â
> GitHub [@rstacruz](https://github.com/rstacruz)  ·Â
> Twitter [@rstacruz](https://twitter.com/rstacruz)
[MIT]: http://mit-license.org/
[contributors]: http://github.com/rstacruz/kingraph/contributors