docs-dev
Installation
Entrypoint
Types
DocsDev

docs-dev

Dagger docs toolchain

Installation

dagger install github.com/shykes/dagger/toolchains/docs-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe

Entrypoint

Return Type

DocsDev !

Arguments

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

Example

dagger -m github.com/shykes/dagger/toolchains/docs-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \

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

@function
def example() -> dagger.DocsDev:
	return (
		dag.docs_dev()
	)

@func()
example(): DocsDev {
	return dag
		.docsDev()
}

Types

DocsDev 🔗

source() 🔗

Return Type

Directory !

Example

dagger -m github.com/shykes/dagger/toolchains/docs-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 source

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

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

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

site() 🔗

Build the docs website

Return Type

Directory !

Example

dagger -m github.com/shykes/dagger/toolchains/docs-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 site

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

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

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

server() 🔗

Build the docs server

Return Type

Container !

Example

dagger -m github.com/shykes/dagger/toolchains/docs-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 server

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

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

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

lintMarkdown() 🔗

Lint documentation files

Return Type

Void !

Arguments

Name	Type	Default Value	Description
markdownFiles	Directory	-	No description provided

Example

dagger -m github.com/shykes/dagger/toolchains/docs-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 lint-markdown

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			DocsDev().
			LintMarkdown(ctx)
}

@function
async def example() -> None:
	return await (
		dag.docs_dev()
		.lint_markdown()
	)

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

generate() 🔗

Regenerate the API schema and CLI reference docs

Return Type

Changeset !

Arguments

Name	Type	Default Value	Description
version	String	-	Dagger version to generate API docs for

Example

dagger -m github.com/shykes/dagger/toolchains/docs-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 generate

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

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

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

bump() 🔗

Bump the Go SDK’s Engine dependency

Return Type

Changeset !

Arguments

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

Example

dagger -m github.com/shykes/dagger/toolchains/docs-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 bump --engine-version string

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

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

@func()
example(engineVersion: string): Changeset {
	return dag
		.docsDev()
		.bump(engineVersion)
}

deploy() 🔗

Deploys a current build of the docs.

Return Type

String !

Arguments

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

Example

dagger -m github.com/shykes/dagger/toolchains/docs-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 deploy --message string --netlify-token env:MYSECRET

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

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

@func()
async example(message: string, netlifyToken: Secret): Promise<string> {
	return dag
		.docsDev()
		.deploy(message, 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/toolchains/docs-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 publish --netlify-token env:MYSECRET

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

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

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