Skip to content
This repository has been archived by the owner on May 5, 2020. It is now read-only.
Viv Rajkumar edited this page Feb 28, 2015 · 11 revisions

MaidSafe Website wiki

Requirements

The new website structure requires Nodejs, Ruby, Jekyll to be installed on your machine in order to build the website.

Jekyll (Linux/MAC): http://jekyllrb.com/docs/installation/

Jekyll (Windows): http://jekyll-windows.juthilo.com

Build Process

Fork this repo & clone your fork locally. Checkout to the next branch. next branch is where you'd want to make any updates from. Run npm install && bower install. Once you have the dependencies installed you should be able to run the grunt scripts from Terminal, Command Prompt etc.

Grunt scripts

1. grunt serve:

Serves the files from the app folder

2. grunt serve:dist

Serves the files from the dist folder (Minified files)

3. grunt test:

Runs linters, link checker and w3c validations

4. grunt build:

Builds the distributable files under the dist folder

5. grunt pr:

Lists the current open Pull Requests. Selected PR is then checked out and served locally for testing.

6. grunt clean-branch:

List the local branches to delete

Update Instructions

Please use the next branch to make any updates and not master branch directly.

Update the files in the app folder (folders starting with _ will not be copied to the dist folder). _includes folder will host dependencies that can be called in the layouts as and when needed _layouts folder will host the common layouts used in the website. Layouts are called from the templates

Note: The files added inside _includes folder should also be added to the app/bundler.html file.

Clone this wiki locally