docs: fix theme build documentation (#318)
parent
4f3d48c1d9
commit
39df04c78f
|
@ -9,7 +9,6 @@ toc
|
||||||
macOS
|
macOS
|
||||||
SVG
|
SVG
|
||||||
HC-primary
|
HC-primary
|
||||||
pre-processor
|
|
||||||
pre-build
|
pre-build
|
||||||
submodule
|
submodule
|
||||||
GPL
|
GPL
|
||||||
|
@ -30,3 +29,5 @@ katex
|
||||||
Theming
|
Theming
|
||||||
Favicon[s]?
|
Favicon[s]?
|
||||||
UI
|
UI
|
||||||
|
webpack
|
||||||
|
pre-processor[s]?
|
||||||
|
|
|
@ -12,16 +12,16 @@ Geekdoc is a simple Hugo theme for documentations. It is intentionally designed
|
||||||
|
|
||||||
## Build and release process
|
## 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
|
```Shell
|
||||||
# install required packages from package.json
|
# install required packages from package.json
|
||||||
npm install
|
npm install
|
||||||
|
|
||||||
# run gulp pipeline to build required assets
|
# run the build script to build required assets
|
||||||
npx gulp default
|
npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
See the [Getting Started Guide](https://geekdocs.de/usage/getting-started/) for details about the different setup options.
|
See the [Getting Started Guide](https://geekdocs.de/usage/getting-started/) for details about the different setup options.
|
||||||
|
|
|
@ -11,16 +11,16 @@ This page tells you how to get started with the Geekdoc theme, including install
|
||||||
|
|
||||||
## Install requirements
|
## 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
|
```Shell
|
||||||
# install required packages from package.json
|
# install required packages from package.json
|
||||||
npm install
|
npm install
|
||||||
|
|
||||||
# run gulp pipeline to build required assets
|
# run the build script to build required assets
|
||||||
npx gulp default
|
npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
## Using the theme
|
## Using the theme
|
||||||
|
@ -101,10 +101,11 @@ Clone the Geekdoc git repository.
|
||||||
git clone https://github.com/thegeeklab/hugo-geekdoc.git themes/hugo-geekdoc
|
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
|
```Shell
|
||||||
npx gulp default
|
npm install
|
||||||
|
npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
## Deployments
|
## Deployments
|
||||||
|
|
Loading…
Reference in New Issue