Dagger
Search

mdbook

CI pipeline for mdBook-based books.

Non-standard book layouts (book.json + manuscript/) are skipped gracefully:
if book.toml is absent, ci() reports "skip" and returns success. Downstream
repos with custom layouts keep their own build workflow.

Installation

dagger install github.com/chirag127/workflows/dagger/mdbook@c00f0b78c773ec3d2a9a9e01ac8a93646fe95cfe

Entrypoint

Return Type 
Mdbook
Example
dagger -m github.com/chirag127/workflows/dagger/mdbook@c00f0b78c773ec3d2a9a9e01ac8a93646fe95cfe call \

func (m *MyModule) Example() *dagger.Mdbook  {
	return dag.
			Mdbook()
}
@function
def example() -> dagger.Mdbook:
	return (
		dag.mdbook()
	)
@func()
example(): Mdbook {
	return dag
		.mdbook()
}

Types

Mdbook 🔗

build() 🔗

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-No description provided
Example
dagger -m github.com/chirag127/workflows/dagger/mdbook@c00f0b78c773ec3d2a9a9e01ac8a93646fe95cfe call \
 build --source DIR_PATH
func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			Mdbook().
			Build(ctx, source)
}
@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.mdbook()
		.build(source)
	)
@func()
async example(source: Directory): Promise<string> {
	return dag
		.mdbook()
		.build(source)
}

lint() 🔗

Verify internal links. Skipped when book.toml is absent.

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-No description provided
Example
dagger -m github.com/chirag127/workflows/dagger/mdbook@c00f0b78c773ec3d2a9a9e01ac8a93646fe95cfe call \
 lint --source DIR_PATH
func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			Mdbook().
			Lint(ctx, source)
}
@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.mdbook()
		.lint(source)
	)
@func()
async example(source: Directory): Promise<string> {
	return dag
		.mdbook()
		.lint(source)
}

megalint() 🔗

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-No description provided
Example
dagger -m github.com/chirag127/workflows/dagger/mdbook@c00f0b78c773ec3d2a9a9e01ac8a93646fe95cfe call \
 megalint --source DIR_PATH
func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			Mdbook().
			Megalint(ctx, source)
}
@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.mdbook()
		.megalint(source)
	)
@func()
async example(source: Directory): Promise<string> {
	return dag
		.mdbook()
		.megalint(source)
}

ci() 🔗

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-No description provided
Example
dagger -m github.com/chirag127/workflows/dagger/mdbook@c00f0b78c773ec3d2a9a9e01ac8a93646fe95cfe call \
 ci --source DIR_PATH
func (m *MyModule) Example(ctx context.Context, source *dagger.Directory) string  {
	return dag.
			Mdbook().
			Ci(ctx, source)
}
@function
async def example(source: dagger.Directory) -> str:
	return await (
		dag.mdbook()
		.ci(source)
	)
@func()
async example(source: Directory): Promise<string> {
	return dag
		.mdbook()
		.ci(source)
}