hugo
Installation
Entrypoint
Types
Hugo

hugo

No long description provided.

Installation

dagger install github.com/stuttgart-things/dagger/hugo@v0.70.0

Entrypoint

Return Type

Hugo

Example

dagger -m github.com/stuttgart-things/dagger/hugo@65455222342fd3546dbe4971859a967d48bed70d call \

func (m *MyModule) Example() *dagger.Hugo  {
	return dag.
			Hugo()
}

@function
def example() -> dagger.Hugo:
	return (
		dag.hugo()
	)

@func()
example(): Hugo {
	return dag
		.hugo()
}

Types

Hugo 🔗

baseImage() 🔗

Return Type

String !

Example

dagger -m github.com/stuttgart-things/dagger/hugo@65455222342fd3546dbe4971859a967d48bed70d call \
 base-image

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			Hugo().
			Baseimage(ctx)
}

@function
async def example() -> str:
	return await (
		dag.hugo()
		.baseimage()
	)

@func()
async example(): Promise<string> {
	return dag
		.hugo()
		.baseImage()
}

serve() 🔗

Return Type

Service !

Arguments

Name	Type	Default Value	Description
config	File !	-	No description provided
content	Directory !	-	No description provided
name	String	"hugo"	The project name
baseUrl	String	"0.0.0.0"	The base url to use
port	String	"1313"	The Port to use
theme	String	"github.com/joshed-io/reveal-hugo"	The Theme to use

Example

dagger -m github.com/stuttgart-things/dagger/hugo@65455222342fd3546dbe4971859a967d48bed70d call \
 serve --config file:path --content DIR_PATH

func (m *MyModule) Example(config *dagger.File, content *dagger.Directory) *dagger.Service  {
	return dag.
			Hugo().
			Serve(config, content)
}

@function
def example(config: dagger.File, content: dagger.Directory) -> dagger.Service:
	return (
		dag.hugo()
		.serve(config, content)
	)

@func()
example(config: File, content: Directory): Service {
	return dag
		.hugo()
		.serve(config, content)
}

exportStaticContent() 🔗

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
siteDir	Directory !	-	No description provided
theme	String	"github.com/joshed-io/reveal-hugo"	The Theme to use

Example

dagger -m github.com/stuttgart-things/dagger/hugo@65455222342fd3546dbe4971859a967d48bed70d call \
 export-static-content --site-dir DIR_PATH

func (m *MyModule) Example(siteDir *dagger.Directory) *dagger.Directory  {
	return dag.
			Hugo().
			Exportstaticcontent(siteDir)
}

@function
def example(sitedir: dagger.Directory) -> dagger.Directory:
	return (
		dag.hugo()
		.exportstaticcontent(sitedir)
	)

@func()
example(siteDir: Directory): Directory {
	return dag
		.hugo()
		.exportStaticContent(siteDir)
}

buildAndExport() 🔗

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
name	String !	-	No description provided
config	File !	-	No description provided
content	Directory !	-	No description provided
theme	String	"github.com/joshed-io/reveal-hugo"	The Theme to use

Example

dagger -m github.com/stuttgart-things/dagger/hugo@65455222342fd3546dbe4971859a967d48bed70d call \
 build-and-export --name string --config file:path --content DIR_PATH

func (m *MyModule) Example(name string, config *dagger.File, content *dagger.Directory) *dagger.Directory  {
	return dag.
			Hugo().
			Buildandexport(name, config, content)
}

@function
def example(name: str, config: dagger.File, content: dagger.Directory) -> dagger.Directory:
	return (
		dag.hugo()
		.buildandexport(name, config, content)
	)

@func()
example(name: string, config: File, content: Directory): Directory {
	return dag
		.hugo()
		.buildAndExport(name, config, content)
}

buildSyncExport() 🔗

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
name	String !	-	No description provided
config	File !	-	No description provided
content	Directory !	-	No description provided
theme	String	"github.com/joshed-io/reveal-hugo"	The Theme to use
endpoint	String !	-	No description provided
accessKey	Secret !	-	No description provided
secretKey	Secret !	-	No description provided
bucketName	String !	-	No description provided
aliasName	String !	-	No description provided
insecure	Boolean !	-	No description provided

Example

dagger -m github.com/stuttgart-things/dagger/hugo@65455222342fd3546dbe4971859a967d48bed70d call \
 build-sync-export --name string --config file:path --content DIR_PATH --endpoint string --access-key env:MYSECRET --secret-key env:MYSECRET --bucket-name string --alias-name string --insecure boolean

func (m *MyModule) Example(name string, config *dagger.File, content *dagger.Directory, endpoint string, accessKey *dagger.Secret, secretKey *dagger.Secret, bucketName string, aliasName string, insecure bool) *dagger.Directory  {
	return dag.
			Hugo().
			Buildsyncexport(name, config, content, endpoint, accessKey, secretKey, bucketName, aliasName, insecure)
}

@function
def example(name: str, config: dagger.File, content: dagger.Directory, endpoint: str, accesskey: dagger.Secret, secretkey: dagger.Secret, bucketname: str, aliasname: str, insecure: bool) -> dagger.Directory:
	return (
		dag.hugo()
		.buildsyncexport(name, config, content, endpoint, accesskey, secretkey, bucketname, aliasname, insecure)
	)

@func()
example(name: string, config: File, content: Directory, endpoint: string, accessKey: Secret, secretKey: Secret, bucketName: string, aliasName: string, insecure: boolean): Directory {
	return dag
		.hugo()
		.buildSyncExport(name, config, content, endpoint, accessKey, secretKey, bucketName, aliasName, insecure)
}

syncMinioBucket() 🔗

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
endpoint	String !	-	No description provided
accessKey	Secret !	-	No description provided
secretKey	Secret !	-	No description provided
bucketName	String !	-	No description provided
aliasName	String !	-	No description provided
insecure	Boolean !	-	No description provided

Example

dagger -m github.com/stuttgart-things/dagger/hugo@65455222342fd3546dbe4971859a967d48bed70d call \
 sync-minio-bucket --endpoint string --access-key env:MYSECRET --secret-key env:MYSECRET --bucket-name string --alias-name string --insecure boolean

func (m *MyModule) Example(endpoint string, accessKey *dagger.Secret, secretKey *dagger.Secret, bucketName string, aliasName string, insecure bool) *dagger.Directory  {
	return dag.
			Hugo().
			Syncminiobucket(endpoint, accessKey, secretKey, bucketName, aliasName, insecure)
}

@function
def example(endpoint: str, accesskey: dagger.Secret, secretkey: dagger.Secret, bucketname: str, aliasname: str, insecure: bool) -> dagger.Directory:
	return (
		dag.hugo()
		.syncminiobucket(endpoint, accesskey, secretkey, bucketname, aliasname, insecure)
	)

@func()
example(endpoint: string, accessKey: Secret, secretKey: Secret, bucketName: string, aliasName: string, insecure: boolean): Directory {
	return dag
		.hugo()
		.syncMinioBucket(endpoint, accessKey, secretKey, bucketName, aliasName, insecure)
}

initSite() 🔗

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
name	String !	-	No description provided
config	File !	-	No description provided
content	Directory !	-	No description provided
theme	String	"github.com/joshed-io/reveal-hugo"	The Theme to use

Example

dagger -m github.com/stuttgart-things/dagger/hugo@65455222342fd3546dbe4971859a967d48bed70d call \
 init-site --name string --config file:path --content DIR_PATH

func (m *MyModule) Example(name string, config *dagger.File, content *dagger.Directory) *dagger.Directory  {
	return dag.
			Hugo().
			Initsite(name, config, content)
}

@function
def example(name: str, config: dagger.File, content: dagger.Directory) -> dagger.Directory:
	return (
		dag.hugo()
		.initsite(name, config, content)
	)

@func()
example(name: string, config: File, content: Directory): Directory {
	return dag
		.hugo()
		.initSite(name, config, content)
}

mergeMarkdowns() 🔗

MergeMarkdowns reads a presentation YAML file, fetches all referenced markdowns (either from src directory or via HTTP), sorts them by order, and returns a merged markdown file

Return Type

File !

Arguments

Name	Type	Default Value	Description
src	Directory !	-	No description provided
presentationFile	File !	-	No description provided

Example

dagger -m github.com/stuttgart-things/dagger/hugo@65455222342fd3546dbe4971859a967d48bed70d call \
 merge-markdowns --src DIR_PATH --presentation-file file:path

func (m *MyModule) Example(src *dagger.Directory, presentationFile *dagger.File) *dagger.File  {
	return dag.
			Hugo().
			Mergemarkdowns(src, presentationFile)
}

@function
def example(src: dagger.Directory, presentationfile: dagger.File) -> dagger.File:
	return (
		dag.hugo()
		.mergemarkdowns(src, presentationfile)
	)

@func()
example(src: Directory, presentationFile: File): File {
	return dag
		.hugo()
		.mergeMarkdowns(src, presentationFile)
}