Skip to content

Latest commit

 

History

History
65 lines (46 loc) · 2.16 KB

README.md

File metadata and controls

65 lines (46 loc) · 2.16 KB
Raw

scotttodd.github.io

This is the source for my website.

It uses GitHub Pages for easy hosting, Jekyll for static site generation, and Jekyll Bootstrap for its many blog features and theming support.

To build a similar site, check out GitHub's Using Jekyll with Pages and Jekyll Bootstrap's Jekyll Quickstart.

Development Instructions

First time build (Windows 10):

  1. Install Ruby: official website. Tested on 2.7.4 (see what the GitHub Pages gem uses).
  2. Install the Ruby Development Kit from here, following the instructions here.
  3. gem install bundler
  4. bundle update
  5. bundle install

Updating/managing gems:

  • gem list
  • gem dependency
  • gem update github-pages, see GitHub Pages Dependency versions
  • bundle update

Standard workflow commands:

  • rake server (supports livereload)
  • rake test
  • rake lint

Or run directly:

  • bundle exec jekyll serve --livereload (easier to terminate)

Directory Structure

I mostly use the basic Jekyll structure.

The 'custom' theme is forked from the 'twitter' theme.

Here are the main areas that I've worked in:

├─── pages (general webpages)
├─── _posts (project webpages)
├─── assets (supporting non-text content)
│   ├─── css
│   ├─── images
│   ├─── js
│   ├─── projects
│   └─── themes
│       └─── custom
└─── _includes (layouts and page templates)
    └─── themes
        └─── custom

License

This site is open sourced under the MIT license, though the projects showcased may have their own licenses.