https://github.com/bih/careers.mlh.io
The Major League Hacking Careers page.
https://github.com/bih/careers.mlh.io
Last synced: 8 months ago
JSON representation
The Major League Hacking Careers page.
- Host: GitHub
- URL: https://github.com/bih/careers.mlh.io
- Owner: bih
- Created: 2016-07-19T00:12:39.000Z (almost 10 years ago)
- Default Branch: gh-pages
- Last Pushed: 2016-07-11T19:30:32.000Z (almost 10 years ago)
- Last Synced: 2024-12-28T01:40:40.020Z (over 1 year ago)
- Language: CSS
- Homepage: http://careers.mlh.io
- Size: 6.03 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
MLH Site Boilerplate
========================================
This is the boilerplate that [Major League Hacking (MLH)][mlh] uses in the
development of static websites. It combines [Jekyll][jekyll] with
[Gulp][gulp] to speed up common development tasks.
## Setup
Before you start, make sure you have [npm][npm-install] installed and the
relevant version of Ruby (probably using [rvm][rvm]).
You will also need [gulp][gulp] and [bundler][bundler] eventually, so lets get
those now too.
```bash
$ npm install -g gulp
$ gem install bundler
```
Now let's install the development dependencies by running the NPM installer and
bundler:
```bash
$ npm install
$ bundle install
```
**Note:** These steps may require the use of `sudo` depending on your
environment.
## Developing
To launch the development server, just run gulp:
```bash
$ gulp
```
## Gulp Commands
An overview of the Gulp commands available:
### `gulp build`
Builds the site into the `_site` directory.
- Cleans any precompiled assets in `_site`
- Lints and compiles SASS
- Lints and compiles Javascript
- Optimizes images
- Compiles the Jekyll site
### `gulp serve`
Spins up the Jekyll server for local development
- Watch the `js/`, `_sass/`, and `img/` directories for changes and run
related tasks
- Spin up the Jeykll server with `--watch` and `--incremental` enabled
- Watch the `_site/` directory for changes and sync to browser
## Structure
```bash
├── .gitignore # Defines which files Git should diregard
├── .ruby-version # Defines the required version of Ruby
├── .scss-lint.yml # Rules for linting SASS files
├── Gemfile # Ruby Dependencies
├── Gemfile.lock # Ruby Dependencies with explicit versions
├── README.md # How to use this project
├── _config.yml # Jekyll configuration
├── _includes/ # Jekyll HTML partials
└── head.html # HTML for the tag
├── _layouts/ # Jekyll HTML layouts
└── default.html # The default template for HTML pages
├── _sass/ # Stylesheets directory
├── _base.scss # Base styles
├── _layout.scss # Grid system
├── _typography.scss # Typography tyles
├── _util.scss # SASS helper functions
├── lib/ # External CSS libraries
├── animate.mn.scss # CSS animations
└── reset.min.scss # CSS reset
└── main.scss # Variable definitions and list of SASS partials to compile
├── gulpfile.js # Defines gulp tasks for development
├── img/ # Images and SVGs
├── index.html # The default HTML page
├── js/ # Javascript libraries and scripts
├── app.js # The default Javascript file
├── app.min.js # The minified default Javascript file
└── lib/ # External JS libraries
└── jquery-2.2.2.min.js # jQuery
└── package.json # Javascript Dependencies
```
## Special Thanks
Big shout out to the [Minimill Project Template](https://github.com/minimill/project-template)
for inspiring this project.
[mlh]: http://mlh.io
[jekyll]: https://jekyllrb.com
[gulp]: http://gulpjs.com/
[npm-install]: https://nodejs.org/en/download/
[rvm]: https://rvm.io/
[bundler]: http://bundler.io/