michaellehmkuhl / life Public

forked from cheeaun/life

Notifications You must be signed in to change notification settings
Fork 0
Star 0

Life - a timeline of important events in my life

cheeaun.github.io/life/

0 stars 610 forks Branches Tags Activity

Notifications

Name		Name	Last commit message	Last commit date
Latest commit History 40 Commits
README.md		README.md
config.example.json		config.example.json
index.html		index.html
life.example.md		life.example.md

Repository files navigation

Life

This is something that I've wanted to build for a long time. It's a timeline of important events in my life, visualized in a way my mind always imagine it. There was something called Lifepath.me but now it's gone. How about Facebook timeline? Meh.

So, this is it. Have a look at cheeaun.github.io/life.

Features

Super simple
No fancy formatting
No fancy setup
No fancy effects
Flexible datetimes because sometimes you don't remember the exact date of an event

< 6D16 div class="markdown-heading" dir="auto">

How to contribute

Fork this project.
Write code.
Make pull requests.

How to setup your own Life

Fork this project.
git checkout -b gh-pages (or any branch name you like)
Make a copy of life.example.md, rename it to life.md.
Add your life events into life.md.
Preview it on a local server. Use python -m SimpleHTTPServer or http-server.
Commit life.md (not in master branch).
git push origin gh-pages -f and publish to GitHub Pages.

How to upgrade your Life

git checkout master
git remote add cheeaun https://github.com/cheeaun/life.git
git fetch cheeaun and git merge cheeaun/master to upgrade to latest Life.
git checkout gh-pages and git merge master to sync changes back to GitHub Pages.

Learn more.

For those who forked the earlier version of Life, these are the steps that I would recommend (requires some Git-fu):

Backup your life.md.
Reset (hard) your fork to this repo's master branch.
Clean up your gh-pages.
Re-commit your life.md there.
Make sure your master branch is untouched so that future updates work.

How to configure your Life

Make a copy of config.example.json, rename it to config.json.
Only commit it in gh-pages branch.

The configuration:

customStylesheetURL - (string, default to null) Path to a custom stylesheet file, for those who doesn't like the default theme.
yearLength - (number, default to 120) The width of the year grids, in pixels.
hideAge - (boolean, default to false) Option to hide age from year axis.