risherry

Risherry began as a customizable personal website and portfolio build using Bootstrap, Handlebars and JQuery frameworks. It also incorporates Sass, Font Awesome and Google Fonts.

Quick Start

If you want to customize locally the sources you will need Node.js and npm.

The build system uses Grunt with plugins like watch, sass, and cssmin. The plugins are installed and managed via npm.

npm install

Install all dependencies.

npm run build

Build all themes by compiling SCSS to CSS and minifying the output.

npm run sass

Compile SCSS files to CSS only.

npm run cssmin

Minify CSS files only.

npm run watch

Launch the watch task that monitors file changes and automatically compiles and minifies the CSS sources.

You should run the build tasks on the src/sass files and commit the results in the dist folder.

Customizing

Content

The content it's easily customizable since it reads the data from JSON.

risherry/
├── src/
    ├── data/
    │   ├── config.json
    │   ├── content.json
    ├── js/
    └── sass/

Themes

By default, there are default available themes.

Each of these themes have a custom.scss and a variables.scss file, that contain the theme's definition. New themes can be created and used.

risherry/
├── src/
    ├── data/
    ├── js/
    └── sass/
        ├── skin/
        ├── style.scss
        └── themes/
            └── default/
                ├── custom.scss
                └── variables.scss

Testing

Test your changes using a local web server. Depending on your configuration there might be changes between the master and the ghpages branches.