diff --git a/.dictionary b/.dictionary index 2d70b4d..9a1cc86 100644 --- a/.dictionary +++ b/.dictionary @@ -9,7 +9,6 @@ toc macOS SVG HC-primary -pre-processor pre-build submodule GPL @@ -30,3 +29,5 @@ katex Theming Favicon[s]? UI +webpack +pre-processor[s]? 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. diff --git a/exampleSite/content/en/usage/getting-started.md b/exampleSite/content/en/usage/getting-started.md index c5c924f..b5b987d 100644 --- a/exampleSite/content/en/usage/getting-started.md +++ b/exampleSite/content/en/usage/getting-started.md @@ -11,16 +11,16 @@ This page tells you how to get started with the Geekdoc theme, including install ## Install requirements -You need a recent version of Hugo for local builds and previews of sites that use Geekdoc. As we are using [gulp](https://gulpjs.com/) as pre-processor the normal version of Hugo is sufficient. If you prefer the extended version of Hugo anyway this will work as well. For comprehensive Hugo documentation, see [gohugo.io](https://gohugo.io/documentation/). +You need a recent version of Hugo for local builds and previews of sites that use Geekdoc. As we are using [webpack](https://webpack.js.org/) as pre-processor, the normal version of Hugo is sufficient. If you prefer the extended version of Hugo anyway this will work as well. For comprehensive Hugo documentation, see [gohugo.io](https://gohugo.io/documentation/). -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. +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 ``` ## Using the theme @@ -101,10 +101,11 @@ Clone the Geekdoc git repository. git clone https://github.com/thegeeklab/hugo-geekdoc.git themes/hugo-geekdoc ``` -Build required theme assets e.g. CSS files and SVG sprites with `gulp`. +Build required theme assets e.g. CSS files and SVG sprites. ```Shell -npx gulp default +npm install +npm run build ``` ## Deployments