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

github.com/jbub/ghostwriter.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJuraj Bubniak <juraj.bubniak@gmail.com>2017-01-05 00:17:18 +0300
committerGitHub <noreply@github.com>2017-01-05 00:17:18 +0300
commit142aedbed2cf7c0a0e4c7d189b2499656573be13 (patch)
treea35ed7123229454e2d7580df809459376fd7dcc9
parentd82d4732d3f91edba07f55c941052cf02371adb8 (diff)
WIP: Webpack integration (#14)
Use webpack for building sass and css dist.
-rw-r--r--README.md27
-rw-r--r--package.json4
2 files changed, 28 insertions, 3 deletions
diff --git a/README.md b/README.md
index 556155b..0a2edce 100644
--- a/README.md
+++ b/README.md
@@ -6,12 +6,33 @@ Enhanced port of the Ghost "[ghostwriter](https://github.com/roryg/ghostwriter)"
Inside the folder of your Hugo site run:
- $ mkdir themes
- $ cd themes
- $ git clone https://github.com/jbub/ghostwriter
+```bash
+$ mkdir themes
+$ cd themes
+$ git clone https://github.com/jbub/ghostwriter
+```
For more information read the official [setup guide](//gohugo.io/overview/installing/) of Hugo.
+## Development
+
+After installing the theme you need to install javascript dependencies. You can use
+`npm` or `yarn` to install them from `package.json`. We are using `webpack` to build
+and package styles. In order to develop with realtime reloading in the browser you can
+use this powerful combo:
+
+```bash
+hugo server
+yarn run watch
+```
+
+To update theme styles edit the `styles/style.scss` file. You can then either use the `watch` command
+or run `build` to compile the styles:
+
+```bash
+yarn run build
+```
+
## Example config.toml
To customize your theme you can use following params:
diff --git a/package.json b/package.json
index bf18de8..b9ca603 100644
--- a/package.json
+++ b/package.json
@@ -5,6 +5,10 @@
"repository": "git@github.com:jbub/ghostwriter.git",
"author": "jbub <contact@jbub.eu>",
"license": "MIT",
+ "scripts": {
+ "build": "webpack",
+ "watch": "webpack --progress --colors --watch"
+ },
"devDependencies": {
"css-loader": "^0.26.1",
"extract-text-webpack-plugin": "^1.0.1",