- Mac Command Line Tools
xcode-select --install - Install Homebrew
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" - Install nvm using Homebrew
brew install nvm - Install Yarn
brew install yarn - Install Jekyll
gem install jekyll - Install Gulp
npm install -g gulp-cli
- Clone the repo
- Get the right node version
nvm use - Install all dev dependencies
yarn - Build all of the assets
gulp build - Open a locally hosted copy of the files in your browser
gulp serve
- Use
gulpto build your files and watch your source files to have them be built automatically - Files are being served from the
_sitefolder
_data- yaml files containing data_includes- HTML partials for each section_layouts- holds page layoutsbase.html- main skeleton for site
_scripts- JavaScript for the sitemodules- module JavaScript filesvendor- vendor JavaScript filesmain.js- entry point for the JavaScript modules
_scss- stylespartials- scss partials for each sectionmain.scss- general styles, each partial gets imported in this file
_site- built static sitefonts- font filesgulp- gulp task files which are injected into the gulpfileimg- images.editorconfig- sets coding styles for IDEs.nvmrc- indicates node version_config.yml- general info for the site.gitignore- specifies git ignoresgulpfile.js- entry point for build scriptsindex.html- where HTML partials are imported (from_includes)package.json- specifies npm dependenciesyarn.lock- specifies package versions for yarn