ScottLogic/beautify-site

Name: beautify-site

Owner: Scott Logic Ltd

Description: the beautify.io website

Created: 2013-09-11 10:52:57.0

Updated: 2015-09-21 21:21:21.0

Pushed: 2017-11-01 16:57:39.0

Homepage: null

Size: 7110

Language: CSS

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Beautify.io

The beautify.io website, built using Jekyll. Currently the site is being served at beautify.github.io/beautify-site.

Dependencies

This project makes use of git submodules for local development. To pull in the code of the submodules run the following from the root of the project -

git submodule init
git submodule update
Testing locally

The Jekyll website has some good instructions of the required configuration for Github Pages. To preview the site locally use the Jekyll server:

jekyll serve --baseurl ''

This will server the site at localhost:4000.

Building for release

The build process compiles the less into CSS and optimises the JavaScript code. The build makes use of the lessc and uglify node modules, both of which need to be installed as command line modules:

npm install -g less
npm install -g uglify-js

The project has a simple script that runs the compilation process, simply run the following:

$ build.sh

When all is beautiful, push to gh-pages.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.