Dagger
Search

markdown-lint

No long description provided.

Installation

dagger install github.com/dagger/dagger/modules/markdownlint@5ddc959e15f4486a5d56ff6fb82b93c98ad7b7f1

Entrypoint

Return Type 
MarkdownLint !
Arguments
NameTypeDefault ValueDescription
versionString -The version of markdownlint to use.
Example
dagger -m github.com/dagger/dagger/modules/markdownlint@5ddc959e15f4486a5d56ff6fb82b93c98ad7b7f1 call \

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

Types

MarkdownLint 🔗

A Dagger module for markdownlint, a markdown linter. https://github.com/DavidAnson/markdownlint-cli2

version() 🔗

The version of markdownlint to use.

Return Type 
String !
Example
dagger -m github.com/dagger/dagger/modules/markdownlint@5ddc959e15f4486a5d56ff6fb82b93c98ad7b7f1 call \
 version
func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			MarkdownLint().
			Version(ctx)
}
@function
async def example() -> str:
	return await (
		dag.markdown_lint()
		.version()
	)
@func()
async example(): Promise<string> {
	return dag
		.markdownLint()
		.version()
}

inputs() 🔗

Filter the current workspace for use by markdownlint.

Return Type 
Directory !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			MarkdownLint().
			Inputs()
}
@function
def example() -> dagger.Directory:
	return (
		dag.markdown_lint()
		.inputs()
	)
@func()
example(): Directory {
	return dag
		.markdownLint()
		.inputs()
}

sandbox() 🔗

Build a sandbox with markdownlint installed and input files mounted.

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example() *dagger.Container  {
	return dag.
			MarkdownLint().
			Sandbox()
}
@function
def example() -> dagger.Container:
	return (
		dag.markdown_lint()
		.sandbox()
	)
@func()
example(): Container {
	return dag
		.markdownLint()
		.sandbox()
}

lint() 🔗

Lint markdown files in the current workspace.

Return Type 
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			MarkdownLint().
			Lint(ctx)
}
@function
async def example() -> None:
	return await (
		dag.markdown_lint()
		.lint()
	)
@func()
async example(): Promise<void> {
	return dag
		.markdownLint()
		.lint()
}

fix() 🔗

Fix markdown files in the current workspace.

Return Type 
Changeset !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example() *dagger.Changeset  {
	return dag.
			MarkdownLint().
			Fix()
}
@function
def example() -> dagger.Changeset:
	return (
		dag.markdown_lint()
		.fix()
	)
@func()
example(): Changeset {
	return dag
		.markdownLint()
		.fix()
}