Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/mattstratton/castanet.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Stratton <matt.stratton@gmail.com>2019-11-11 19:56:42 +0300
committerGitHub <noreply@github.com>2019-11-11 19:56:42 +0300
commit7e258516c88d59ab4d1c2bc0f273783c79534df2 (patch)
tree8029bf5a770bf31572b333e1d51aa0c43d9fcdbe /CONTRIBUTING.md
parentba311bbb777d8e97e5d455678b72abcafe4976f1 (diff)
Move to gulp (#224)
* Small changes to theme config file Signed-off-by: Matt Stratton <matt.stratton@gmail.com> * Update to use gulp This will remove the need for codekit and lets `gulp dev` be the method for building stylesheets and javascript files Signed-off-by: Matt Stratton <matt.stratton@gmail.com> * Update docs for clarity on new styles Signed-off-by: Matt Stratton <matt.stratton@gmail.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md21
1 files changed, 11 insertions, 10 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d96298f..0f9bbdf 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,14 +3,13 @@
The technical details on how to set up your local development environment for making changes to the `castanet` [Hugo](https://gohugo.io/) theme for podcasts.
# Table of contents
-<!-- TOC depthFrom:2 -->
+<!-- TOC depthfrom:2 -->
- [Set up your environment](#set-up-your-environment)
- [Git remote setup](#git-remote-setup)
- [Installing dependencies](#installing-dependencies)
- [Install Node.js and npm](#install-nodejs-and-npm)
- [Install gulp](#install-gulp)
- - [Install bower](#install-bower)
- [Install node modules](#install-node-modules)
- [How can I help?](#how-can-i-help)
- [Making changes](#making-changes)
@@ -26,6 +25,7 @@ The technical details on how to set up your local development environment for ma
- [`custom.scss`](#customscss)
- [Javascript](#javascript)
- [Local build and testing](#local-build-and-testing)
+ - [Build new javascript and stylesheets](#build-new-javascript-and-stylesheets)
- [Continuous Integration](#continuous-integration)
- [Issues](#issues)
- [GitHub Labels](#github-labels)
@@ -43,10 +43,9 @@ The technical details on how to set up your local development environment for ma
Prerequisites:
* `make` (note - this is not needed yet)
-* `gulp` v3.9.1+ (not needed yet)
-* `bower`
+* `gulp` v4.0.0+
* `nodejs` and `npm`
-* [hugo v0.36.1+](https://gohugo.io)
+* [hugo v0.58.3+](https://gohugo.io)
Clone `castanet` from source into your working directory of choice:
@@ -92,8 +91,6 @@ https://docs.npmjs.com/getting-started/installing-node
#### Install gulp
`npm install --global gulp`
-#### Install bower
-`npm install --global bower`
#### Install node modules
@@ -178,7 +175,11 @@ All Javascript files are combined using CodeKit. The source Javascript files can
## Local build and testing
-TODO - add gulp information and make scripts
+### Build new javascript and stylesheets
+
+Inside the theme directory, run `npm install`.
+
+Run `gulp dev` to build the compiled stylesheets and Javascript files
## Continuous Integration
The `castanet` repo has hooks into Travis, Appveyor, and Netlify. Currently, the Travis build doesn’t do very much (the intent is to add some testing using Casper.js for web testing, but no tests have been written). The Appveyor tests ensure that the site can build with Windows.
@@ -228,10 +229,10 @@ See [utils/README](https://github.com/mattstratton/castanet/blob/master/utils/RE
Adding a color theme is quite simple - you will need to generate two new files for the theme:
-- `static/scss/<MYCOLOR>_varibles.scss`
+- `static/scss/<MYCOLOR>_variables.scss`
- `static/scss/<MYCOLOR.scss`
-The `_variables.scss` file contains the Sass varibles uses to build the stylesheet. `<MYCOLOR>` should refer to the name of the style as you will set it in the `config.toml`.
+The `<MYCOLOR>_variables.scss` file contains the Sass variables uses to build the stylesheet. `<MYCOLOR>` should refer to the name of the style as you will set it in the `config.toml`.
## Developer Certification of Origin (DCO)