stand alone

Using this template as a stand-alone website

If you want to have a repository for your website which is completely separate from the repository where you are documenting your research, you can simply clone this repository with the following in the command line

git clone https://github.com/gchure/reproducible_website my_project_website

This will make a complete copy of this repository and store it locally on your machine with the folder name my_project website. You can then navigate into the directory and make the changes as is listed in the configuration page of this wiki.

Using this template in a branch of another repository

An alternative approach to using this template is to define the website on a new branch of another repository. This, in my opinion, is a better approach towards making your research reproducible as you will tie the actual research history to the data that is being presented on the website. This procedure is a bit more complicated, however, as is outlined in the following steps:

1. Clone this template repository to your machine with the new name template_website:

git clone https://github.com/gchure/reproducible_website template_website

2. Navigate to your research repository and make a new branch called gh-pages

cd my_project_repo
git checkout -b gh-pages

3. Copy all folders from the template repository in to your new branched research repository

cp -r template_website/* my_project_repo

4. Add all of the new files to the gh-pages branch, commit, and push to remote

git add .
git commit -m 'Initial commit of website files'
git push origin gh-pages