diff options
author | Digitalcraftsman <digitalcraftsman@protonmail.com> | 2020-06-12 21:29:59 +0300 |
---|---|---|
committer | Digitalcraftsman <digitalcraftsman@protonmail.com> | 2020-06-12 21:29:59 +0300 |
commit | 448b2731e322c597563ceaa18c3cae066c403328 (patch) | |
tree | bc65369bc3370cee1a8293ca00f8bad560c6f184 | |
parent | dc9943156a4400809f8ab737d5568be428a1ca23 (diff) |
Add instructions for reviewTheme.sh to _script/README.md
-rw-r--r-- | _script/README.md | 40 |
1 files changed, 33 insertions, 7 deletions
diff --git a/_script/README.md b/_script/README.md index 7052ae9..34e9068 100644 --- a/_script/README.md +++ b/_script/README.md @@ -1,30 +1,56 @@ -# hugoThemeSiteScript -Script to generate Hugo's Theme Site +# How to generate Hugo's theme site + +This document describes how to generate the Hugo theme site for different scenarios. + +## Complete build + +This script generates Hugo's theme site (as on [www.themes.gohugo.io](https://themes.gohugo.io/)) +by downloading all added themes. + +**Note:** Takes a long time and is requires a lot of disk space. To test it locally, add the root of the baseUrl as first argument: -``` +```bash ./generateThemeSite.sh http://localhost:1313 ``` +## Quick build for theme reviews / tests + +To test a single theme use the `reviewTheme.sh` script. It uses a dedicated +directory to store themes used to build Hugo's theme site. Thus, build time +decreases significantly. By default, `./review` is used. + +To test it locally, add the url to the Git repository that contains the to be +tested theme. **Optionally**, change the dedicated directory with flag `-t`. + +Whitelist your theme in `./generateThemeSite.sh` if necessary. + +```bash +./reviewTheme.sh <repo> -t <path> +``` + +Hugo's theme site will be served automatically at [http://localhost:1313](http://localhost:1313). + +## Environment variables + To alter the Hugo themes repository used (contains all themes to display), provide a value for the environment variable `HUGO_THEMES_REPO`. -``` +```bash HUGO_THEMES_REPO=<repo> ./generateThemeSite.sh http://localhost:1313 ``` To alter the Hugo theme site repository used, provide a value for the environment variable `HUGO_THEME_SITE_REPO`. -``` +```bash HUGO_THEME_SITE_REPO=<repo> ./generateThemeSite.sh http://localhost:1313 ``` To alter the Hugo example site repository used, provide a value for the environment variable `HUGO_EXAMPLE_SITE_REPO`. -``` +```bash HUGO_EXAMPLE_SITE_REPO=<repo> ./generateThemeSite.sh http://localhost:1313 ``` - |