github/hugo-geekblog
0
0
Fork 0
mirror of https://github.com/thegeeklab/hugo-geekblog.git synced 2024-11-21 20:50:40 +00:00
Code Issues Projects Releases Wiki Activity

fix wording in build docs (#184)

Browse Source
This commit is contained in:
Robert Kaussow 2022-02-03 14:41:47 +01:00 committed by GitHub
parent 0d574c8f9d
commit 34d89cef80
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.dictionary
View File

@ -12,7 +12,6 @@ img
JSON JSON
SVG SVG
YAML YAML
pre-processor
pre-build pre-build
submodule submodule
GPL GPL
@ -34,4 +33,4 @@ whitespace
Theming Theming
Favicon[s]? Favicon[s]?
webpack webpack
pre-processor(s) pre-processor[s]?

2
README.md
View File

@ -16,7 +16,7 @@ Geekblog is a simple Hugo theme for personal blogs. It is intentionally designed
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-geekblog/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-geekblog/releases).
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 build script 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

2
exampleSite/content/posts/usage/getting-started.md
View File

@ -38,7 +38,7 @@ Geekblog is a simple Hugo theme for personal blogs. It is intentionally designed
You need a recent version of Hugo for local builds and previews of sites that use Geekblog. 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/). You need a recent version of Hugo for local builds and previews of sites that use Geekblog. 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 `webpack` 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