docs
Installation
Entrypoint
Types
Docs

docs

No long description provided.

Installation

dagger install github.com/shykes/dagger/docs@1b60778efd3ee9a3f016f730649244ceecd76ff8

Entrypoint

Return Type

Docs !

Arguments

Name	Type	Default Value	Description
source	Directory	-	No description provided
nginxConfig	File	-	No description provided

Example

dagger -m github.com/shykes/dagger/docs@1b60778efd3ee9a3f016f730649244ceecd76ff8 call \

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

@function
def example() -> dagger.Docs:
	return (
		dag.docs()
	)

@func()
example(): Docs {
	return dag
		.docs()
}

Types

Docs 🔗

source() 🔗

Return Type

Directory !

Example

dagger -m github.com/shykes/dagger/docs@1b60778efd3ee9a3f016f730649244ceecd76ff8 call \
 source

func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			Docs().
			Source()
}

@function
def example() -> dagger.Directory:
	return (
		dag.docs()
		.source()
	)

@func()
example(): Directory {
	return dag
		.docs()
		.source()
}

site() 🔗

Build the docs website

Return Type

Directory !

Example

dagger -m github.com/shykes/dagger/docs@1b60778efd3ee9a3f016f730649244ceecd76ff8 call \
 site

func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			Docs().
			Site()
}

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

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

server() 🔗

Build the docs server

Return Type

Container !

Example

dagger -m github.com/shykes/dagger/docs@1b60778efd3ee9a3f016f730649244ceecd76ff8 call \
 server

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			Docs().
			Server()
}

@function
def example() -> dagger.Container:
	return (
		dag.docs()
		.server()
	)

@func()
example(): Container {
	return dag
		.docs()
		.server()
}

checkLint() 🔗

Lint documentation files

Return Type

Void !

Example

dagger -m github.com/shykes/dagger/docs@1b60778efd3ee9a3f016f730649244ceecd76ff8 call \
 check-lint

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			Docs().
			CheckLint(ctx)
}

@function
async def example() -> None:
	return await (
		dag.docs()
		.check_lint()
	)

@func()
async example(): Promise<void> {
	return dag
		.docs()
		.checkLint()
}

generate() 🔗

Regenerate the API schema and CLI reference docs

Return Type

Changeset !

Arguments

Name	Type	Default Value	Description
check	Boolean	-	Check that no generation was needed. Use this in CI, when it's too late to actually generate, but you need to enforce that developers remembered to do it.
version	String	-	Dagger version to generate API docs for

Example

dagger -m github.com/shykes/dagger/docs@1b60778efd3ee9a3f016f730649244ceecd76ff8 call \
 generate

func (m *MyModule) Example() *dagger.Changeset  {
	return dag.
			Docs().
			Generate()
}

@function
def example() -> dagger.Changeset:
	return (
		dag.docs()
		.generate()
	)

@func()
example(): Changeset {
	return dag
		.docs()
		.generate()
}

introspection() 🔗

Return Type

File !

Arguments

Name	Type	Default Value	Description
version	String	-	No description provided

Example

dagger -m github.com/shykes/dagger/docs@1b60778efd3ee9a3f016f730649244ceecd76ff8 call \
 introspection

func (m *MyModule) Example() *dagger.File  {
	return dag.
			Docs().
			Introspection()
}

@function
def example() -> dagger.File:
	return (
		dag.docs()
		.introspection()
	)

@func()
example(): File {
	return dag
		.docs()
		.introspection()
}

bump() 🔗

Bump the Go SDK’s Engine dependency

Return Type

Changeset !

Arguments

Name	Type	Default Value	Description
version	String !	-	No description provided

Example

dagger -m github.com/shykes/dagger/docs@1b60778efd3ee9a3f016f730649244ceecd76ff8 call \
 bump --version string

func (m *MyModule) Example(version string) *dagger.Changeset  {
	return dag.
			Docs().
			Bump(version)
}

@function
def example(version: str) -> dagger.Changeset:
	return (
		dag.docs()
		.bump(version)
	)

@func()
example(version: string): Changeset {
	return dag
		.docs()
		.bump(version)
}

deploy() 🔗

Deploys a current build of the docs.

Return Type

String !

Arguments

Name	Type	Default Value	Description
netlifyToken	Secret !	-	No description provided

Example

dagger -m github.com/shykes/dagger/docs@1b60778efd3ee9a3f016f730649244ceecd76ff8 call \
 deploy --netlify-token env:MYSECRET

func (m *MyModule) Example(ctx context.Context, netlifyToken *dagger.Secret) string  {
	return dag.
			Docs().
			Deploy(ctx, netlifyToken)
}

@function
async def example(netlify_token: dagger.Secret) -> str:
	return await (
		dag.docs()
		.deploy(netlify_token)
	)

@func()
async example(netlifyToken: Secret): Promise<string> {
	return dag
		.docs()
		.deploy(netlifyToken)
}

publish() 🔗

Publish a previous deployment to production - defaults to the latest deployment on the main branch.

Return Type

Void !

Arguments

Name	Type	Default Value	Description
netlifyToken	Secret !	-	No description provided
deployment	String	-	No description provided

Example

dagger -m github.com/shykes/dagger/docs@1b60778efd3ee9a3f016f730649244ceecd76ff8 call \
 publish --netlify-token env:MYSECRET

func (m *MyModule) Example(ctx context.Context, netlifyToken *dagger.Secret)   {
	return dag.
			Docs().
			Publish(ctx, netlifyToken)
}

@function
async def example(netlify_token: dagger.Secret) -> None:
	return await (
		dag.docs()
		.publish(netlify_token)
	)

@func()
async example(netlifyToken: Secret): Promise<void> {
	return dag
		.docs()
		.publish(netlifyToken)
}