Skip to content

einsteinpy/einsteinpy.org

Repository files navigation

EinsteinPy Main Site

This is the GitHub repository for the EinsteinPy Project Main Site, einsteinpy.org. The Main Site is a portal to guide users to other project resources and sites. The repository for the source code of EinsteinPy itself can be found at github.com/einsteinpy/einsteinpy.

Full docs for setting up a GitHub Pages Jekyll blog can be found here.

Building Locally

Using Docker

After installing docker, run make serve to build and run the website within the a container built from the jekyll/jekyll image that contains all the necessary prerequisites. The site will be available at http://localhost:4000. Modifying source files will cause the website to rebuild in real time (refresh the browser page to see changes).

Manually

To build manually, you will need to have Ruby>=2.1 installed on your system. If necessary, run

gem install bundler

The first time you build locally you will need to install necessary dependcies. In the top level direcotory of this repository, run:

bundle install

Then, to serve the site, run:

bundle exec jekyll serve

The site will be available at http://localhost:4000. While this program remains running, you can edit the source files and Jekyll will automatically rebuild the site (refresh the browser page to see changes).