This site was built with Jekyll—a static site generator. Props to Jon Suh for initial site architecture and Readme creation.
- Jekyll—see the official documentation for requirements for installing Jekyll.
- Node
The following are instructions for compiling and developing the site. For more about Jekyll, read the official Quick-start guide.
- Clone the project and
cd
into the directory. - Run
npm install && bundle
to install dependencies.
- Most of the markup lives in
index.html
. index.html
relies on the default layout file,_layouts/default.html
.
- CSS is compiled via Sass in the
SCSS
syntax—Jekyll comes with Sass support. - Files are located in
assets/css
—assets/css/site.scss
is the manifest.
- JS files are in
assets/js
.
bundle exec jekyll build
performs a compile of the site.- The production-ready files are generated in the
_site
directory.
bundle exec jekyll serve
creates a local development environment—point your browser tohttp://localhost:4000
.
I included some niceties if you’d like some extra, development-friendly tools. This requires:
The following are commands that you may find helpful:
npm run watch
: run development environment—point your browser tohttp://localhost:3000
. This includes CSS hot-reloading—see CSS changes instantly without reloading the browser.npm run dist
: creates production-ready files—_site
directory—which includes compressing CSS and uglifying JS.