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

github.com/thegeeklab/hugo-geekdoc.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Kaussow <mail@geeklabor.de>2022-02-03 16:41:42 +0300
committerGitHub <noreply@github.com>2022-02-03 16:41:42 +0300
commit39df04c78f4466b372e994cb756032f0d58c5477 (patch)
tree55582e87fd802aed923ba33c1555066b6892c692 /README.md
parent4f3d48c1d9088a7c4baf1023bf08add12982be26 (diff)
docs: fix theme build documentation (#318)
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 2080479..5bf4b3a 100644
--- a/README.md
+++ b/README.md
@@ -12,16 +12,16 @@ Geekdoc is a simple Hugo theme for documentations. It is intentionally designed
## Build and release process
-This theme is subject to a CI driven build and release process common for software development. During the release build, all necessary assets are automatically built by [gulp](https://gulpjs.com/) and bundled in a release tarball. You can download the latest release from the GitHub [release page](https://github.com/thegeeklab/hugo-geekdoc/releases).
+This theme is subject to a CI driven build and release process common for software development. During the release build, all necessary assets are automatically built by [webpack](https://webpack.js.org/) and bundled in a release tarball. You can download the latest release from the GitHub [release page](https://github.com/thegeeklab/hugo-geekdoc/releases).
-Due to the fact that `gulp` is used as pre-processor the theme cannot be used from the main branch by default. If you want to use the theme from a cloned branch instead of a release tarball you'll need to install `gulp` locally and run the default pipeline once to create all required assets.
+Due to the fact that `webpack` and `npm scripts` are used as pre-processors, the theme cannot be used from the main branch by default. If you want to use the theme from a cloned branch instead of a release tarball you'll need to install `webpack` locally and run the build script once to create all required assets.
```Shell
# install required packages from package.json
npm install
-# run gulp pipeline to build required assets
-npx gulp default
+# run the build script to build required assets
+npm run build
```
See the [Getting Started Guide](https://geekdocs.de/usage/getting-started/) for details about the different setup options.