JSON Resume Website

Visit the website at https://jsonresume.org/

Development

There are two ways to run this website, locally or inside a VM.

Locally

Dependencies:

• Git
• Debian-based OS (e.g. Ubuntu)

1. Clone repository

git clone https://github.com/jsonresume/resume-website.git

2. Install Jekyll

Start by installing this stuff:

sudo apt-get install ruby ruby-dev make

ruby and gem should now have been installed on your computer.

Now go ahead and install Jekyll:

sudo gem install jekyll --no-rdoc --no-ri

3. Run Jekyll

Step into the resume-website/ folder and run:

jekyll serve --watch

This will run the Jekyll server and watch for any file changes.

VM

Dependencies:

• Vagrant
• VirtualBox

Simply run:

vagrant up
vagrant ssh
jekyll serve

Then open http://localhost:4000/.

The initial provision will take some time.

Note: The --watch flag for Jekyll has issues inside the VM, see Stack Overflow and jekyll/jekyll#1763.

Deploying

This repository is comprised of 2 branches.

• main - To maintain the sources for the website.
• gh-pages - A built version of the website, hosted via GitHub Pages.

This split is to allow the use of unsupported Jekyll plugins, which prevents GitHub Pages from building the site.

GitHub Pages cannot build sites using unsupported plugins. If you want to use unsupported plugins, generate your site locally and then push your site's static files to GitHub.
- About GitHub Pages and Jekyll

Pull requests should be made to the main branch.

Resources

Installing Jekyll on Ubuntu: http://michaelchelen.net/81fa/install-jekyll-2-ubuntu-14-04/

License

Available under the MIT license.