hugo-theme-bootstrap-algolia

command module

v0.1.2 Latest Latest Go to latest Published: Nov 27, 2022 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

A CLI Application for HBS theme.

Download from Releases.

Name	Required	Default	Description
`ALGOLIA_APP_ID`	YES	-	The Algolia App ID.
`ALGOLIA_API_KEY`	YES	-	The Algolia Admin API KEY.
`ALGOLIA_INDEX_NAME`	YES	-	The Algolia App Index Name.
`ALGOLIA_INDEX_FILE`	NO	`public/algolia/index.json`, relative to your working directory.

This tool requires several env vars to be set, there are multiple ways to do that.

via command line

ALGOLIA_APP_ID=x \
ALGOLIA_API_KEY=y \
ALGOLIA_INDEX_NAME=z \
hugo-theme-bootstrap-algolia

via .env file

Create the .env file under your site root with following form.

ALGOLIA_APP_ID=x
ALGOLIA_API_KEY=y
ALGOLIA_INDEX_NAME=z
#ALGOLIA_INDEX_FILE=public/algolia/index.json

You should never commit the .env file, since it contains sensitive data, you can ignore it via .gitignore.

echo .env >> .gitignore

This program should be ran after building site, since it need to access and upload the index file.

$ hugo

$ hugo-theme-bootstrap-algolia

There is no documentation for this package.

Path	Synopsis
internal