A workflow UI project for the Jekyll base cms site.
If you're on a Mac: Run ./install-script.sh
to install NPM dependencies, Jekyll, and Sass. This will also check to make sure you have Homebrew, Ruby, and Node installed as well, and if not, will download them for you.
If you're on a Windows or Linux computer: please be sure to have Ruby, Rubygems, Jekyll and Sass gems, Node, npm, and Grunt installed. The install-script.sh
file made for Mac terminals will not work for you.
Check out the _config.yml
file first, to set your variables. This config file is read only once when you start your server; so if you make changes to this file while your server is running, you will need to restart your server to see the changes.
On your local computer: Run jekyll server
to serve locally.
In a separate terminal tab/window, run sass watch
to watch for changes in assets/scss
and compile your Sass files into CSS, the result of which is your styles end up in assets/css/main.min.css
and included in your site's head
tag.
The following commands can be run from the console.
Compiles the site and runs from the source. Watches the source and updates the served pages as required.
Compiles the site into the the deploy folder.
Runs a gulp task that removes/deletes the folder where the site is deployed to
Runs a gulp task that performs linting for the site - html validation, bootstrap validation and js hint validation.
Runs a gulp task that compiles the sass into css
Runs a gulp task that watches the sass folder and compiles after any changes.
The gulp tasks have a custom config file in the workflow folder. This defines the projects paths for source, deploy, sass and css. It can be extended as required and used in any of the gulp files as config..
The workflow folder contains all of the js scripts which define the gulp tasks. The tasks are organised in grouped files to make reading them easier.
- File tree with
_data/
,_includes/
,_layouts/
,_posts/
,_site/
,assets/
,category/
,tag/
and other subfolders. - Asset setup with Sass. gulp setup for managing assets.
- Initial categories and tags structures, and corresponding layouts.