Skip to content

hunterunger/simple-family-tree-creator

Repository files navigation

Family tree maker banner

Simple Family Tree Maker

Try the live editor at family-tree-maker.oxen.dev.

The goal of this project is to make a platform-independent syntax to help record family trees. All other formats will die out, or become paid-to-use, but the mighty text file is here to stay.

This format is based off of YAML and compiles to Mermaid JS. It's easy to use, but can be parsed into trees easily.

Features

Use a simple YAML syntax to create a visual family tree.

Here's an example of the family syntax:

Mom Peterson + Dad Smith [Optional Title]:
    - Charlie
    - Ty
    - Brian

Also check out the following larger examples:

Flowchart Output

(This might not render, depending on your markdown viewer.)

flowchart TB

%% GENERATION 0%%
DadSmith("Dad Peterson") --- DadMom(Optional Title)
MomWillson("Mom Willson") --- DadMom(Optional Title)

DadMom(Optional Title) --> Child1Smith("Charlie Smith")
DadMom(Optional Title) --> Child2Smith("Ty Smith")
DadMom(Optional Title) --> Child3Smith("Brian Smith")

Local Setup

This is made with Next.js 13 and the /app router.

Run npm i;npm run dev to start the server on localhost:3000.