Host your docs on Github pages

Template for lab and code documentation

TLDR

Stanford Docster is a template you can easily customize for your code and lab documentation, and publish on Github pages. You can preview the theme, or go directly to download.

Features

• Nice syntax highlighting
• dynamic multi-level navigation

QuickStart

Clone, make changes to files in _entries and _config.yml and push to Github! More specifically:

      git clone https://github.com/researchapps/template-jekyll-github
      cd template-jekyll-github

1. Option 1: Docker

Download docker, download the template to a folder, and run a container:

      docker run --label=jekyll --volume=$(pwd):/srv/jekyll -it -p 127.0.0.1:4000:4000 jekyll/jekyll

Then go to 127.0.0.1:4000 in your browser to see the site! Make changes, add the files to your github folder (either the master branch of your user or organization repo (a repo named in the format myusername.github.io) or the gh-pages branch of another repo, which will appear at myusername.github.io/reponame.

1. Option 2: Run Locally

Install Jekyll and then run with:

      jekyll serve

Documentation

Check out the demo, and the repository on Github for complete documentation.

Need Help?

We made this for you, and we want it to fit your needs. If you want to request an improvement, please submit an issue. If you need help, please reach out to us.