path: root/_script/generateThemeSite.sh

#!/bin/bash

function try() {
	"$@"
	code=$?
	if [ $code -ne 0 ]; then
		echo "$1 failed: exit status $code"
		exit 1
	fi
}

function fixReadme() {
	local content=$(cat $1)
	# Make images viewable outside GitHub
	content=$(echo "$content" | perl -p -e 's/github\.com\/(.*?)\/blob\/master\/images/raw\.githubusercontent\.com\/$1\/master\/images/g;')
	# Tell Hugo not to process shortcode samples
	content=$(echo "$content" | perl -0pe 's/\{\{%([^\/].*?)%\}\}/{{%\/*$1*\/%}}/sg;')
	content=$(echo "$content" | perl -0pe 's/\{\{<([^\/].*?)>\}\}/{{<\/*$1*\/>}}/sg;')

	echo "$content"
}

function fixThemeTOML() {
	local content=$(cat $1)

	# Make sure min_version is string, i.e min_version = 0.20.1 => min_version = "0.20.1"
	content=$(echo "$content" | perl -pe 's/min_version = (\d\S*)\n/min_version = "$1"\n/sg;')

	echo "$content"
}

# Silent pushd
pushd() {
	command pushd "$@" >/dev/null
}

# Silent popd
popd() {
	command popd "$@" >/dev/null
}

# Load the repositories from the provided environment variables or our defaults
HUGO_THEME_SITE_REPO=${HUGO_THEME_SITE_REPO:-https://github.com/gohugoio/hugoThemesSite.git}
HUGO_BASIC_EXAMPLE_REPO=${HUGO_BASIC_EXAMPLE_REPO:-https://github.com/gohugoio/hugoBasicExample.git}

echo "Using ${HUGO_THEME_SITE_REPO} for theme site"
echo "Using ${HUGO_BASIC_EXAMPLE_REPO} for example site"

GLOBIGNORE=.*
siteDir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/hugoThemeSite"
# use HUGO_THEMES_REPO to specify alternative location as source for themes. Intended to speed up
# build times for theme submission reviews by ignoring already added themes.
themesDir=${HUGO_THEMES_REPO:-"$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"}

echo "Using themes dir ${themesDir}"
echo "Using site dir ${siteDir}"

configTplPrefix="config-tpl"
configBase="${configTplPrefix}-base"
configBaseParams="${configTplPrefix}-params"

export HUGO_THEMESDIR=${themesDir}

# This is the hugo Theme Site Builder
mkdir -p hugoThemeSite

pushd hugoThemeSite

if [ -d themeSite ]; then
	pushd themeSite
	git pull --rebase --recurse-submodules origin master
	git submodule update --init --recursive
	popd
else
	git clone --recursive ${HUGO_THEME_SITE_REPO} themeSite
fi

if [ -d exampleSite ]; then
	pushd exampleSite
	git pull --rebase
	popd
else
	git clone ${HUGO_BASIC_EXAMPLE_REPO} exampleSite
fi


echo "BUILDING FROM" `pwd`

# Clean before new build
try rm -rf themeSite/public
try rm -rf themeSite/static/theme
try rm -rf themeSite/static/images
try rm -rf exampleSite2

mkdir -p themeSite/content
mkdir -p themeSite/static/images

if [ $# -eq 1 ]; then
	BASEURL="$1"
else
	BASEURL="http://themes.gohugo.io"
fi

blacklist=('.git', '.github')
# hugo-theme-w3css-basic: the theme owner requested disabling of the theme demo, see https://github.com/gohugoio/hugoThemes/issues/555
# devfest-theme-hugo: providing an exampleSite folders requires a lot of work, see https://github.com/gohugoio/hugoThemes/issues/584#issuecomment-467193735
# docsy documentation theme whose author does not wish to provide an exampleSite for reasons discussed in https://github.com/gohugoio/hugoThemes/issues/650
# hugo-theme-tony: currently the demo does not comply with repo rules, for more info
# hugo-geekblog: theme owner requested to host theme himself for technical reasons. See https://github.com/gohugoio/hugoThemes/issues/904
# hugo-geekdoc: theme owner requested to host theme himself for technical reasons. See https://github.com/gohugoio/hugoThemes/issues/914
# hugo-PaperMod: theme requested to self-host demo due to constraints set by the build script. See https://github.com/gohugoio/hugoThemes/issues/906
# uBlogger: theme owner preferred self-hosted demo. See https://github.com/gohugoio/hugoThemes/issues/952
# doks: theme owner requested self-hosted demo. See https://github.com/gohugoio/hugoThemes/issues/950
# less: theme requires extened version of Hugo. See https://github.com/gohugoio/hugoThemes/issues/867#issuecomment-762583303
# hugo-theme-stack: theme owner requested to host theme himself for technical reasons. See https://github.com/gohugoio/hugoThemes/issues/994
# toha: the theme owner requested disabling of the theme demo, see https://github.com/gohugoio/hugoThemes/issues/999
noDemo=('hugo-theme-w3css-basic', 'devfest-theme-hugo', 'docsy', 'hugo-geekblog', 'hugo-geekdoc', 'hugo-PaperMod', 'uBlogger', 'doks', 'less', 'hugo-theme-stack', 'toha')

# A theme that uses other components needs to be added to this array
components=('hugo-bare-min-theme')

# academic: Popular theme aimed towards academia
# reveal-hugo: Presentation theme that depends on reveal.js
# hugo-terrassa-theme: business theme where hugoBasicExamples's content doesn't match the context
# hugo-theme-learn: documentation theme with custom shortcodes and own docs
# hugo-now-ui: Bootstrap-based material theme with custom docs and shortcodes for components
# cupper-hugo-theme: Theme with accessibility features
# hugo-book: e-book theme needs its own content
# yourfolio: portfolio theme needs its own content
# hugo-resume: complicated resume theme needs its own content
# hugo-mdl: author parameter is an inline table
# hugo-dream-plus : author parameter is an inline table, also this theme needs its own content
# gohugo-theme-ananke: Quick start guide theme
# papercss-hugo-theme: provides custom short codes
# hugo-serif-theme: provides custom content for sub-pages
# hugo-theme-introduction: complicated theme with multilingual mode for several languages
# hugo-alabaster-theme: documentation theme needs its content
# docuapi: documentation theme needs its content
# hugo-theme-winning: single page resume theme draws its content from its own _index.md
# co-op: uses custom sections on the homepage that can be populated via content files
# hugo-piercer-theme: offers customizable sections on the homepage that require own content files
# minimo: is a very customizable theme that ships with widgets
# personal-web: uses custom content files for the portfolio section
# kitab: default content doesn't provide the structure to showcase books with chapters
# syna: the use of fragments requires custom content files
# crab: uses custom content to display features of the theme
# hugograyscale: a one-page theme whose homepage sections aren't covered by the default content
# hugo-creative-portfolio-theme: see https://github.com/gohugoio/hugoThemes/issues/649
# mero: uses custom pages archive and tags / categories. See https://github.com/gohugoio/hugoThemes/issues/593#issuecomment-505934333
# khata: uses custom pages archive and tags / categories
# OneDly-Theme: uses custom content to display subpages and sections on the homepage
# hugo-webslides: uses custom Markdown files for presentation slides
# hugo-theme-novela: uses custom images for post thumbnails and author pictures
# Blogpaper uses custom images
# ticky_tacky_dark uses custom configuration in content files
# hugo-alageek-theme content structure does not fit the hugoBasicExample
# paperesque needs its own content
# ------------------------------------------------------------------------
# the following theme demos require their own content for various reasons:
# ------------------------------------------------------------------------
# hugo-minimalist-spa
# simplicity
# hugo-theme-den
# alpha-church
# castanet 
# hugo-apps-theme
# hugo-theme-techdoc
# hugo-theme-revealjs
# hugo-theme-robotico 
# hugo-travelify-theme
# colordrop: demo is multilingual
# hugo-changelog-theme needs its own content to function
# hugo-owaraiclub supports multiple authors
# hugonews needs its own content
# hugo-theme-zzo complex blog theme with gallery
# northendlab-hugo needs its own content for search to function
# ------------------------------------------------------------------------
# The following are whitelisted Themefisher Themes
# ------------------------------------------------------------------------
# dot-hugo-documentation-theme: business-focused knowledge base theme that require specific structure
# kross-hugo-portfolio-template: requires custom content for the portfolio section
# parsa-hugo-personal-blog-theme: is an image-heavy theme which heavily defines its appearance
# Hargo-hugo-ecommerce-theme complex ecommerce theme
# liva-hugo complex blog theme
# Academia-hugo fork of Academic needs its own content
# ------------------------------------------------------------------------
# engimo: theme for engineers, needs its own content
# compose: documentation theme, needs its own content
# someparts-hugo: uses custom structure for subpages
# hugo-rocinante: uses custom setup to show picture gallery in posts
# hugo-theme-fuji the pagination requires the theme's specific content files
# kiss-em needs its own content files
# ace-documentation: documentation theme needs its own content files
# origin-hugo-theme: needs its own content
# autophugo: need its own content
# ramium: has custom sections
# twenty-twenty-hugo: requires its own content to function
# hugo-theme-console: custom photo gallery section
# LoveIt: requires its own content after latest refactor
# hugo-theme-mixedpaper: pagination requires the provided content
# roxo-hugo: complex product portfolio theme using custom images
# bohdi: uses custom search
# codex: requires custom content for homepage and blog section
# showcase: use custom content for showcase items on homepage
# hugo-theme-notrack: custom content for archive, gallery and biography page needed 
# hugo-theme-color-your-world: demo requires more complex content structure
# persian-hugo: i.e. demo requires more complex content structure
# hugo-icarus: uses custom content for thumbnails in blog posts
# hugo-developer-portfolio: uses custom content for portfolio content
# the-roots-home: custom directory tree
# osprey-delight: enables proper display of new theme features. See #884
# health-science-journal: kind of content is not covered by hugoBasicExample
# habor: uses custom content / shortcodes to implement search. See #892
# gochowdown: Uses custom content (recipes) to function
# hugo-scroll: uses custom content structure for one-page-theme
# hugo-researcher: uses custom content for resume etc.
# hugo-clinic-notes: provides custom content for patient records
# hugo-theme-docport: uses custom content for documentation
# hugo-theme-pico: uses custom content for landing page
# Blonde: uses custom content to display archive and contact form
# portio-hugo: portfolio content not covered by default content
# hugo-bearblog: custom homepage from content file not covered. homepage would remain empty.
# hugo-product-launch: landing page requires custom content file
# bigspring-hugo-startup-theme: requires custom content for contact, pricing, privacy policy subpages
# sicily-hugo-theme: provides custom pages for pricing, contact form, faq etc.
# hugo-theme-timeline: to enable layout for timeline
# hugo-eureka: to new layout for documentations. See #932
# omega-hugo-theme: custom content required for products, career page etc.
whiteList=('academic', 'reveal-hugo', 'hugo-terrassa-theme', 'hugo-theme-learn', 'hugo-now-ui', 'dot-hugo-documentation-theme', 'cupper-hugo-theme', 'hugo-book', 'yourfolio', 'hugo-resume', 'hugo-mdl', 'hugo-dream-plus', 'gohugo-theme-ananke', 'papercss-hugo-theme', 'hugo-serif-theme', 'hugo-theme-introduction', 'hugo-alabaster-theme', 'docuapi', 'hugo-theme-winning', 'co-op', 'hugo-piercer-theme', 'minimo', 'personal-web', 'kitab', 'kross-hugo-portfolio-template', 'parsa-hugo-personal-blog-theme', 'syna', 'crab', 'hugograyscale', 'hugo-creative-portfolio-theme', 'mero', 'khata', 'OneDly-Theme', 'hugo-webslides', 'hugo-minimalist-spa', 'hugo-theme-den', 'simplicity', 'alpha-church', 'castanet', 'hugo-apps-theme', 'hugo-theme-techdoc', 'hugo-theme-revealjs', 'hugo-theme-robotico', 'hugo-travelify-theme', 'colordrop', 'hugo-changelog-theme', 'Hargo-hugo-ecommerce-theme', 'hugo-owaraiclub', 'liva-hugo', 'hugonews', 'Academia-hugo', 'hugo-theme-zzo', 'engimo', 'northendlab-hugo', 'hugo-theme-novela', 'Blogpaper', 'ticky_tacky_dark', 'hugo-alageek-theme', 'paperesque', 'compose', 'someparts-hugo', 'hugo-rocinante', 'hugo-theme-fuji', 'kiss-em', 'ace-documentation', 'origin-hugo-theme', 'autophugo', 'ramium', 'twenty-twenty-hugo', 'hugo-theme-console', 'LoveIt', 'hugo-theme-mixedpaper', 'roxo-hugo', 'bodhi', 'hugo-theme-codex', 'showcase-hugo-theme', 'hugo-theme-notrack', 'hugo-theme-color-your-world', 'persian-hugo', 'hugo-icarus', 'hugo-developer-portfolio', 'the-roots-home', 'osprey-delight', 'bento', 'health-science-journal', 'harbor', 'gochowdown', 'hugo-scroll', 'hugo-researcher', 'hugo-clinic-notes', 'hugo-theme-docport', 'hugo-theme-pico', 'Blonde', 'portio-hugo', 'hugo-bearblog', 'hugo-product-launch', 'bigspring-hugo-startup-theme', 'sicily-hugo-theme', 'hugo-theme-timeline', 'hugo-eureka', 'omega-hugo-theme')

errorCounter=0

for x in `find ${themesDir} -mindepth 1 -maxdepth 1 -type d -not -path "*.git" -not -path "*_script" | xargs -n1 basename`; do

	blacklisted=`echo ${blacklist[*]} | grep -w "$x"`
	if [ "${blacklisted}" != "" ]; then
		echo " ==== SKIPPING " $x " is blacklisted ====== "
		continue
	fi

	generateDemo=true
	inNoDemo=`echo ${noDemo[*]} | grep -w "$x"`
	if [ "${inNoDemo}" != "" ]; then
		generateDemo=false
	fi

	skipEmptySubmodule=false
	if [ ! -f "${themesDir}/$x/theme.toml" ]; then
		echo " ==== SKIPPING " $x " (Submodule Empty) ====== "
		skipEmptySubmodule=true
	fi

	if ! $skipEmptySubmodule; then

	echo " ==== PROCESSING " $x " ====== "
	if [ "${inNoDemo}" != "" ]; then
                echo "${x} is in noDemo list"
	fi
	mkdir -p themeSite/content/$x

	cp ${themesDir}/$x/images/screenshot.png themeSite/content/$x/screenshot-$x.png
	# Use the thumbnail as featured image for the Twitter card etc.
	cp ${themesDir}/$x/images/tn.png themeSite/content/$x/tn-featured-$x.png

	title=$( echo "${x}" | tr "-" " " | awk '{for(i=1;i<=NF;i++)sub(/./,toupper(substr($i,1,1)),$i)}1')

	echo "+++" >themeSite/content/$x/index.md
	echo "title = \"$title\"" >>themeSite/content/$x/index.md
	repo=`git -C ${themesDir}/$x remote -v | head -n 1 | awk '{print$2}'`

	pushd ${themesDir}
	themeCreated=`git log --reverse --pretty=format:"%ai" $x | head -1`
	pushd $x
	themeUpdated=`git log --pretty=format:"%ai" -n1`
	popd
	popd

	if [ -z "$themeCreated" ]; then
		themeCreated=${themeUpdated}
	fi

	echo "date = \"$themeCreated\"" >>themeSite/content/$x/index.md
	echo "lastmod = \"$themeUpdated\"" >>themeSite/content/$x/index.md

	echo "source = \"$repo\"" >>themeSite/content/$x/index.md

	demoDestination="../themeSite/static/theme/$x/"
	demoConfig="${themesDir}/$x/exampleSite/config"
	searchConfig="${themesDir}/$x/exampleSite/config.*"
	taxoConfig="${siteDir}/exampleSite/configTaxo.toml"

	export HUGO_CANONIFYURLS=true

    if $generateDemo; then

        if [ -f "${themesDir}/$x/.gitmodules" ]; then
            pushd ${themesDir}/$x
            echo "Updating git submodules for theme $x"
            git submodule update --init --recursive
            popd
        fi

        if [ -d "${themesDir}/$x/exampleSite" ]; then
        	# Use content and config in exampleSite
            ln -s ${themesDir}/$x/exampleSite ${siteDir}/exampleSite2
            ln -s ${themesDir} ${siteDir}/exampleSite2/themes
            destination="../themeSite/static/theme/$x/"
            inWhiteList=`echo ${whiteList[*]} | grep -w "$x"`
            hasCompontents=`echo ${components[*]} | grep -w "$x"`
            if [ "${inWhiteList}" != "" ]; then
				echo "${x} is whitelisted"
				echo "Building site for theme ${x} using its own exampleSite to ${demoDestination}"
				# Hugo should exit with an error code on these ...
				if [ ! -d "${themesDir}/$x/exampleSite/content" ]; then
					echo "Example site for theme ${x} missing /content folder"
					generateDemo=false
				fi
            	HUGO_THEME=${x} hugo --quiet -s exampleSite2 -d ${demoDestination} -b $BASEURL/theme/$x/
            else
                                grep -v "enableEmoji" ${searchConfig} > temp && mv temp ${searchConfig}
                                find ${themesDir}/$x/layouts/ -type f -exec sed -i -e 's/Pages "Type" "posts"/Pages "Type" "post"/g' -e 's/Pages "Section" "posts"/Pages "Section" "post"/g' {} \;
				echo "Building site for theme ${x} using default content to ${demoDestination}"
                                if [ "${hasCompontents}" != "" ]; then
				echo "Building site for theme ${x} with Theme Components"
                                perl -i -pe 's/kaushalmodi\/hugo-bare-min-theme/gohugoio\/hugoBasicExample/g | s/exampleSite\/content/content/g' ${searchConfig}
				hugo --quiet -s exampleSite2 -c ${siteDir}/exampleSite/content/ --themesDir ${themesDir}/$x/exampleSite/themes/ --config=${demoConfig},${taxoConfig} -d ${demoDestination} -b $BASEURL/theme/$x/
rm -rf ${themesDir}/$x/exampleSite/themes/hugoThemes
				else
				HUGO_THEME=${x} hugo --quiet -s exampleSite2 -c ${siteDir}/exampleSite/content/ --config=${demoConfig},${taxoConfig} -d ${demoDestination} -b $BASEURL/theme/$x/
				fi
            fi
            if [ $? -ne 0 ]; then
                echo "FAILED to create exampleSite for $x"
                errorCounter=$((errorCounter + 1))
                rm -rf ${demoDestination}
                generateDemo=false
            fi
            rm ${siteDir}/exampleSite2/themes
            rm ${siteDir}/exampleSite2

        else

            themeConfig="${siteDir}/config-${x}.toml"
            baseConfig="${configBase}.toml"
            paramsConfig="${configBaseParams}.toml"

            if [ -f "themeSite/templates/${configBase}-${x}.toml" ]; then
                baseConfig="${configBase}-${x}.toml"
            fi

            if [ -f "themeSite/templates/${configBaseParams}-${x}.toml" ]; then
                paramsConfig="${configBaseParams}-${x}.toml"
            fi

            cat themeSite/templates/${baseConfig} >${themeConfig}
            cat themeSite/templates/${paramsConfig} >>${themeConfig}

            echo "Building site for theme ${x} using config \"${themeConfig}\" to ${demoDestination}"
            HUGO_THEME=${x} hugo --quiet -s exampleSite --config=${themeConfig},${taxoConfig} -d ${demoDestination} -b $BASEURL/theme/$x/
            if [ $? -ne 0 ]; then
                echo "FAILED to create demo site for $x"
                rm -rf ${demoDestination}
                errorCounter=$((errorCounter + 1))
                generateDemo=false
            fi
        fi
    fi

	if $generateDemo; then
		echo "demo = \"/theme/$x/\"" >> themeSite/content/$x/index.md
	fi

	fixThemeTOML ${themesDir}/$x/theme.toml >> themeSite/content/$x/index.md
	echo -en "\n+++\n\n" >>themeSite/content/$x/index.md

	if [ -f "${themesDir}/$x/README.md" ]; then
		fixReadme ${themesDir}/$x/README.md >> themeSite/content/$x/index.md
	else
		fixReadme ${themesDir}/$x/readme.md >> themeSite/content/$x/index.md
	fi

	fi

	if ((errorCounter > 50)); then
		echo "FAILED: Too many ($errorCounter) errors!"
		exit 1
	fi

done

unset GLOBIGNORE

echo -en "Finished with $errorCounter errors ...\n"

echo -en "**********************************************************************\n"
echo -en "\n"
echo -en "to view the site locally run 'hugo server -w=false -s _script/hugoThemeSite/themeSite\n"
echo -en "\n"
echo -en "**********************************************************************\n"