mkdocs
Installation
Entrypoint
Types
Mkdocs

mkdocs

This module has been generated via dagger init and serves as a reference to basic module structure as you get started with Dagger.

Two functions have been pre-created. You can modify, delete, or add to them, as needed. They demonstrate usage of arguments and return types using simple echo and grep commands. The functions can be called from the dagger CLI or from one of the SDKs.

The first line in this comment block is a short description line and the rest is a long description with more detail on the module's purpose or usage, if appropriate. All modules should have a short description.

Installation

dagger install github.com/francoissharpe/daggerverse/mkdocs@a7f6d0118c410be1d14d2b41827c9779ade37cdd

Entrypoint

Return Type

Mkdocs

Example

func (m *myModule) example() *Mkdocs  {
	return dag.
			Mkdocs()
}

@function
def example() -> dag.Mkdocs:
	return (
		dag.mkdocs()
	)

@func()
example(): Mkdocs {
	return dag
		.mkdocs()
}

Types

Mkdocs 🔗

ctr() 🔗

Return Type

Container !

Example

func (m *myModule) example() *Container  {
	return dag.
			Mkdocs().
			Ctr()
}

@function
def example() -> dagger.Container:
	return (
		dag.mkdocs()
		.ctr()
	)

@func()
example(): Container {
	return dag
		.mkdocs()
		.ctr()
}

site() 🔗

Return Type

Directory !

Example

func (m *myModule) example() *Directory  {
	return dag.
			Mkdocs().
			Site()
}

@function
def example() -> dagger.Directory:
	return (
		dag.mkdocs()
		.site()
	)

@func()
example(): Directory {
	return dag
		.mkdocs()
		.site()
}

withMkdocsMaterial() 🔗

Returns a container that echoes whatever string argument is provided

Return Type

Mkdocs !

Arguments

Name	Type	Default Value	Description
image	String	"squidfunk/mkdocs-material"	The image to use
version	String	"latest"	The version of the image to use
mkdocsYaml	File	null	Your mkdocs.yml file
docs	Directory	null	Your docs directory
src	Directory	null	Source directory

Example

func (m *myModule) example() *Mkdocs  {
	return dag.
			Mkdocs().
			WithMkdocsMaterial()
}

@function
def example() -> dag.Mkdocs:
	return (
		dag.mkdocs()
		.with_mkdocs_material()
	)

@func()
example(): Mkdocs {
	return dag
		.mkdocs()
		.withMkdocsMaterial()
}

withStaticSiteContainer() 🔗

Return Type

Container !

Arguments

Name	Type	Default Value	Description
image	String	"nginx"	The image to use
version	String	"alpine"	The image version

Example

func (m *myModule) example() *Container  {
	return dag.
			Mkdocs().
			WithStaticSiteContainer()
}

@function
def example() -> dagger.Container:
	return (
		dag.mkdocs()
		.with_static_site_container()
	)

@func()
example(): Container {
	return dag
		.mkdocs()
		.withStaticSiteContainer()
}